Added basic readme

reubenjacob · Feb 13, 2016 · e711b44 · e711b44
1 parent 210f9fd
commit e711b44
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+# A list of projects aiming to improve the internet through decentrali(z|s)ation.
+
+## Where can I view the list?
+
+
+## How to add your project
+
+1. Fork/Clone this repository
+2. Add a new JSON file in the projects/ folder
+3. Make the JSON look like the example below.
+4. Check your JSON is valid
+5. Send a PR
+
+### Example Project JSON file
+
+```json
+{
+    "name": "My project",
+    "description": "My project aims to fix problems with centralisation by....",
+    "languages" : ["C++", "Python"],
+    "homepage": "https://myprojecthomepage",
+    "sourcecode": "https://github.com/..."
+}
+```
+
+If the languages part isn't relevant, just use []. If it's not open (why not?) use "".  All other fields are required.
+
+## How do I add it to a category?
+
+Not yet, working on it.