summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan-Christoph Borchardt <hey@jancborchardt.net>2018-12-02 23:49:27 +0100
committerJan-Christoph Borchardt <hey@jancborchardt.net>2018-12-02 23:49:34 +0100
commitb26c7425092681f9c9c2206c9e3c57dd508e126b (patch)
tree631602a371093b1068e4632d54d8e2a5466b3901 /README.md
parent5bf2411e0a71e21db3e186b2dcda6a91ff985ebd (diff)
Add section on current limitations to readme
Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6b3a6595..6844827a 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,12 @@
**πŸŽ‰ Nextcloud becomes part of the federated social networks!**
-The app is in alpha stage, so it’s time for you to get involved! πŸ‘©β€πŸ’»
+The app is in alpha stage, so it’s time for you to [get involved! πŸ‘©β€πŸ’»](https://github.com/nextcloud/social#development-setup)
+
+Some requirements in this alpha stage are that your Nextcloud:
+- must use a real SSL certificate
+- must be accessible from the internet
+- must run on the default port
Mockup:
![](img/screenshot.png)
@@ -15,8 +20,8 @@ Mockup:
## Development setup
-1. ☁ Clone the app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud-gmbh/social.git`
+1. ☁ Clone the app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/social.git`
2. πŸ‘©β€πŸ’» Run `make dev-setup` to install the dependencies
3. πŸ— To build the Javascript whenever you make changes, run `make build-js`
4. βœ… Enable the app through the app management of your Nextcloud
-5. πŸŽ‰ Partytime!
+5. πŸŽ‰ Partytime! Help fix [some issues](https://github.com/nextcloud/social/issues) and [review pull requests](https://github.com/nextcloud/social/pulls) πŸ‘