From 1e8da01418346b0d8cbe24469fc239b999373cda Mon Sep 17 00:00:00 2001 From: Girish Ramakrishnan Date: Tue, 24 Nov 2015 13:29:18 -0800 Subject: [PATCH] Fix README.md --- README.md | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ea998a6..216e4b6 100644 --- a/README.md +++ b/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= PASSWORD= mocha test.js +```