bootstrap basic docs

AUTHORS.md

@@ -0,0 +1,15 @@
+# Credits
+
+## Development Lead and Copyright Holder
+
+Learning Equality – [email protected]
+
+## Community
+
+Please feel free to add your name to this list if you make a PR
+
+* Rafael Aguayo (ralphiee22)
+* Jamie Alexandre (jamalex)
+* Benjamin Bach (benjaoming)
+* Jose Rodriguez (jredrejo)
+* Aron Asor (aronasorman)

CHANGELOG.md

@@ -0,0 +1,71 @@
+Release Notes
+=============
+
+List of the most important changes for each release.
+
+## 0.4.5
+
+- fixes issue where GET requests with body payload fails
+
+## 0.4.4
+
+- adds gzipping capability on buffer post requests
+- parametrizes chunk size to allow it to be set when initiating sync sessions
+
+## 0.4.3
+
+- remove unused files in dist
+
+## 0.4.2
+
+- Added fix for writing CACHE file on windows
+
+## 0.4.1
+
+- Added fix for writing CACHE file to user directory
+
+## 0.4.0
+
+- Added inverse CSR endpoints for pushing data to a server
+- various performance improvements
+- allow for hard deletion which purges data and is able to propagate to other devices
+
+## 0.3.3
+
+- Add transactions around queuing into buffer and dequeuing into store
+
+## 0.3.2
+
+- Mute signals before deserialization/saving store models
+
+## 0.3.1
+
+- removed logic of loading scope definition fixtures (delegated to main application)
+
+## 0.3.0
+
+- added support for postgres database backend
+
+## 0.2.4
+
+## 0.2.3
+
+## 0.2.2
+
+## 0.2.1
+
+## 0.2.0
+
+## 0.1.1
+
+## 0.1.0
+
+- First working version for morango
+
+## 0.0.2: content-curation compatibility!
+
+- make requirements more flexible
+
+## 0.0.1: the initial release!
+
+- Add in model name to uuid calc.

CONTRIBUTING.md

@@ -0,0 +1,101 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated\! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at <https://github.com/learningequality/morango/issues>.
+
+If you are reporting a bug, please include:
+
+  - Your operating system name and version.
+  - Any details about your local setup that might be helpful in
+    troubleshooting.
+  - Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and
+"help wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with
+"enhancement" and "help wanted" is open to whoever wants to implement
+it.
+
+### Write Documentation
+
+morango could always use more documentation, whether as part of the
+official morango docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at
+<https://github.com/learningequality/morango/issues>.
+
+If you are proposing a feature:
+
+  - Explain in detail how it would work.
+  - Keep the scope as narrow as possible, to make it easier to
+    implement.
+
+## Get Started\!
+
+Ready to contribute? Here's how to set up
+<span class="title-ref">morango</span> for local development.
+
+1.  Fork the <span class="title-ref">morango</span> repo on GitHub.
+
+2.  Clone your fork locally:
+
+        $ git clone [email protected]:your_name_here/morango.git
+
+3.  Install your local copy into a virtualenv. Assuming you have
+    virtualenvwrapper installed, this is how you set up your fork for
+    local development:
+
+        $ mkvirtualenv morango
+        $ cd morango/
+        $ python setup.py develop
+
+4.  Create a branch for local development:
+
+        $ git checkout -b name-of-your-bugfix-or-feature
+
+    Now you can make your changes locally.
+
+5.  When you're done making changes, check that your changes pass flake8
+    and the tests, including testing other Python versions with tox:
+
+        $ flake8 morango tests
+        $ python setup.py test or py.test
+        $ tox
+
+    To get flake8 and tox, just pip install them into your virtualenv.
+
+6.  Commit your changes and push your branch to GitHub:
+
+        $ git add .
+        $ git commit -m "Your detailed description of your changes."
+        $ git push origin name-of-your-bugfix-or-feature
+
+7.  Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1.  The pull request should include tests.
+2.  If the pull request adds functionality, the docs should be updated.
+    Put your new functionality into a function with a docstring, and add
+    the feature to the list in README.rst.
+3.  The pull request should work for Python 2.7, 3.4 and 3.5. Check
+    <https://travis-ci.org/learningequality/morango/pull_requests> and
+    make sure that the tests pass for all supported Python versions.

MANIFEST.in

@@ -1,3 +1,7 @@
+include AUTHORS.md
+include CONTRIBUTING.md
+include CHANGELOG.md
+include LICENSE
 include README.md
 
 include requirements.txt

README.md

@@ -1,9 +1,7 @@
 # Morango
 
 [![image](https://img.shields.io/travis/learningequality/morango.svg)](https://travis-ci.org/learningequality/morango)
-
 [![image](http://codecov.io/github/learningequality/morango/coverage.svg?branch=master)](http://codecov.io/github/learningequality/morango?branch=master)
-
 [![image](https://readthedocs.org/projects/morango/badge/?version=latest)](http://morango.readthedocs.org/en/latest/)
 
 Pure Python Django DB replication engine.

docs/authors.rst

@@ -1 +1,4 @@
-.. include:: ../AUTHORS.rst
+.. _authors:
+
+
+.. mdinclude:: ../AUTHORS.md

docs/changelog.rst

@@ -0,0 +1,3 @@
+.. _changelog:
+
+.. mdinclude:: ../CHANGELOG.md