Ver código fonte

Fix README.md

Girish Ramakrishnan 9 anos atrás
pai
commit
1e8da01418
1 arquivos alterados com 33 adições e 6 exclusões
  1. 33 6
      README.md

+ 33 - 6
README.md

@@ -1,9 +1,36 @@
-Gogs App
-========
+# Gogs Cloudron App
 
-[![Install on Cloudron](https://cloudron.io/img/installbutton32.png)](https://cloudron.io/)
+This repository contains the Cloudron app package source for [Gogs](http://gogs.io/).
 
-Source
-------
-https://github.com/gogits/gogs
+## Installation
+
+[![Install](https://cloudron.io/img/button32.png)](https://cloudron.io/button.html?app=io.gogs.cloudronapp)
+
+or using the [Cloudron command line tooling](https://cloudron.io/references/cli.html)
+
+```
+cloudron install --appstore-id io.gogs.cloudronapp
+```
+
+## Building
+
+The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
+
+```
+cd gogs-app
+
+cloudron build
+cloudron install
+```
+
+## Testing
+
+The e2e tests are located in the `test/` folder and require [nodejs](http://nodejs.org/). They are creating a fresh build, install the app on your Cloudron, perform tests, backup, restore and test if the repos are still ok.
+
+```
+cd gogs-app/test
+
+npm install
+USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha test.js
+```