Browse Source

Add full README

Eric Holscher 9 years ago
parent
commit
54d648af8a
1 changed files with 40 additions and 3 deletions
  1. 40 3
      README.rst

+ 40 - 3
README.rst

@@ -1,4 +1,41 @@
-Read the Docs template
-======================
+Template
+========
 
-A template that gets you started with a Read the Docs project.
+$project will solve your problem of where to start with documentation,
+by providing a basic explanation of how to do it easily.
+
+Look how easy it is to use:
+
+    import project
+    # Get your stuff done
+    project.do_stuff()
+
+Features
+--------
+
+- Be awesome
+- Make things faster
+
+Installation
+------------
+
+Install $project by running:
+
+    install project
+
+Contribute
+----------
+
+- Issue Tracker: github.com/$project/$project/issues
+- Source Code: github.com/$project/$project
+
+Support
+-------
+
+If you are having issues, please let us know.
+We have a mailing list located at: project@google-groups.com
+
+License
+-------
+
+The project is licensed under the BSD license.