update readmes (#51)

CODE_OF_CONDUCT.md

@@ -0,0 +1,17 @@
+# Kulprit Community Code of Conduct
+
+Be kind to others. Do not insult or put down others.
+Behave professionally. Remember that harassment and sexist, racist,
+or exclusionary jokes are not appropriate.
+
+All communication should be appropriate for a professional audience
+including people of many different backgrounds. Sexual language and
+imagery are not appropriate.
+
+Kulprit is dedicated to providing a harassment-free community for everyone,
+regardless of gender, sexual orientation, gender identity, and
+expression, disability, physical appearance, body size, race,
+or religion. We do not tolerate harassment of community members
+in any form.
+
+Thank you for helping make this a welcoming, friendly community for all.

README.md

@@ -1,16 +1,29 @@
-# kulprit
-
-_(Pronounced: kuːl.prɪt)_
+<img src="https://raw.githubusercontent.com/bambinos/kulprit/main/docs/logos/kulprit_flat.png" width=200></img>
 
 Kullback-Leibler projections for Bayesian model selection in Python.
 
+[![PyPi version](https://badge.fury.io/py/kulprit.svg)](https://badge.fury.io/py/kulprit)
+[![Build Status](https://github.com/bambinos/kulprit/actions/workflows/test.yml/badge.svg)](https://github.com/bambinos/kulprit/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/bambinos/kulprit/branch/main/graph/badge.svg?token=SLJIK2O4C5)](https://codecov.io/gh/bambinos/kulprit)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+
+
+## Overview
+
+Kulprit _(Pronounced: kuːl.prɪt)_ is a package for variable selection for [Bambi](https://github.com/bambinos/bambi) models.
+
 
 ## Installation
 
-Currently, this package is only available for download directly from GitHub with the command
-```bash
-pip install git+https://github.com/bambinos/kulprit.git
-```
+Kulprit requires a working Python interpreter (3.9+). We recommend installing Python and key numerical libraries using the [Anaconda Distribution](https://www.anaconda.com/products/individual#Downloads), which has one-click installers available on all major platforms.
+
+Assuming a standard Python environment is installed on your machine (including pip), Kulprit itself can be installed in one line using pip:
+
+    pip install kulprit
+
+Alternatively, if you want the bleeding edge version of the package you can install from GitHub:
+
+    pip install git+https://github.com/bambinos/kulprit.git
 
 ## Documentation
 
@@ -20,3 +33,22 @@ The Kulprit documentation can be found in the [official docs](https://kulprit.re
 ## Development
 
 Read our development guide in [CONTRIBUTING.md](https://github.com/bambinos/kulprit/blob/main/CONTRIBUTING.md).
+
+
+## Contributions
+
+Kulprit is a community project and welcomes contributions. Additional information can be found in the [Contributing](https://github.com/bambinos/kulprit/blob/main/docs/CONTRIBUTING.md) Readme.
+
+For a list of contributors see the [GitHub contributor](https://github.com/bambinos/kulprit/graphs/contributors) page
+
+## Donations
+
+If you want to support Kulprit financially, you can [make a donation](https://numfocus.org/donate-to-pymc) to our sister project PyMC.
+
+## Code of Conduct
+
+Kulprit wishes to maintain a positive community. Additional details can be found in the [Code of Conduct](https://github.com/bambinos/kulprit/blob/main/docs/CODE_OF_CONDUCT.md)
+
+## License
+
+[MIT License](https://github.com/bambinos/kulprit/blob/main/LICENSE)

docs/index.rst

@@ -24,11 +24,19 @@ Kulprit is tested on Python 3.9+.
 Installation
 ============
 
-Currently, this package is only available for download directly from GitHub with the command:
+Kulprit requires a working Python interpreter (3.9+). We recommend installing Python and key numerical libraries using the [Anaconda Distribution](https://www.anaconda.com/products/individual#Downloads), which has one-click installers available on all major platforms.
+
+Assuming a standard Python environment is installed on your machine (including pip), Kulprit itself can be installed in one line using pip:
+
+.. code-block:: bash
+
+    pip install kulprit
+
+Alternatively, if you want the bleeding edge version of the package you can install from GitHub:
 
 .. code-block:: bash
 
-  pip install git+https://github.com/bambinos/kulprit.git
+    pip install git+https://github.com/bambinos/kulprit.git
 
 
 Contributing
@@ -40,6 +48,13 @@ Contributors
 ============
 See the `GitHub contributor page <https://github.com/bambinos/kulprit/graphs/contributors>`_.
 
+
+Donations
+============
+
+If you want to support Kulprit financially, you can `make a donation <https://numfocus.org/donate-to-pymc>`_ to our sister project PyMC.
+
+
 Contents
 ========