Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite README #18

Merged
merged 5 commits into from May 19, 2018
Merged

Rewrite README #18

merged 5 commits into from May 19, 2018

Conversation

thejunglejane
Copy link
Contributor

Closes #4

@thejunglejane thejunglejane self-assigned this May 19, 2018
@thejunglejane thejunglejane added this to To do in Open source via automation May 19, 2018
@thejunglejane thejunglejane moved this from To do to In progress in Open source May 19, 2018
README.rst Outdated
:target: https://marbles.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/twosigma/marbles/shield.svg
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not use pyup for this.


.. code-block:: bash

pip install marbles
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's link to the contributing docs and I think we need to mention the license at the end of this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mention the license up at the top

leifwalsh
leifwalsh previously approved these changes May 19, 2018
GitHub rendering was not respecting the ..include directive :(
@thejunglejane thejunglejane merged commit e4ab030 into master May 19, 2018
Open source automation moved this from In progress to Done May 19, 2018
@thejunglejane thejunglejane deleted the docs/readme branch May 19, 2018 20:54
@thejunglejane thejunglejane restored the docs/readme branch May 19, 2018 21:11
@thejunglejane thejunglejane deleted the docs/readme branch May 19, 2018 21:14
thejunglejane added a commit that referenced this pull request May 19, 2018
Updating README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Open source
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants