README and CONTRIBUTING

Author: matburt

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Receptor Contributing Guidelines
+
+Hi there! We're excited to have you as a contributor.
+
+If you have questions about this document or anything not covered here? Come chat with us `#receptor` on irc.freenode.net
+
+## Things to know prior to submitting code
+
+- All code and doc submissions are done through pull requests against the `master` branch.
+- Take care to make sure no merge commits are in the submission, and use `git rebase` vs `git merge` for this reason.
+
+## Setting up your development environment
+
+It's entirely possible to develop on **Receptor** simply with
+
+```bash
+(host)$ python setup.py develop
+```
+
+## Linting and Unit Tests
+
+* Use `flake8` for linting.
+* Use `pytest` for unit tests.

README.md

@@ -0,0 +1,14 @@
+Receptor
+==============
+
+[![Documentation](https://readthedocs.org/projects/receptor/badge/?version=stable)](https://receptor.readthedocs.io/en/latest/)
+
+
+For the latest documentation see: [https://receptor.readthedocs.io](https://receptor.readthedocs.io/en/latest/)
+
+Get Involved
+============
+
+* We use [GitHub issues](https://github.com/project-receptor/receptor/issues) to track bug report and feature ideas...
+* Want to contribute, check out our [guide](CONTRIBUTING.md)
+* Join us in the `#receptor` channel on Freenode IRC