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

Update README and setup.py #21

Merged
merged 9 commits into from
Aug 16, 2019
Merged

Update README and setup.py #21

merged 9 commits into from
Aug 16, 2019

Conversation

fatcat2
Copy link

@fatcat2 fatcat2 commented Aug 15, 2019

Updating the README with instructions on how to set up a dev environment/how to use!

@busunkim96
Copy link

What versions of Python can this be used with? It would be nice to have that information in the README and the setup.py. 😄

releasetool's setup.py

Copy link
Contributor

@kurtisvg kurtisvg left a comment

Choose a reason for hiding this comment

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

I think you should re-frame this into 3 sections:

  • "How to install this connector"
  • "How to use this connector"
  • "How to make changes to this connector as a developer"

As a user of the library, I probably don't care about running tests or making changes. (but I do care about how I need to use it)

@fatcat2 fatcat2 changed the title Update README with development instructions Update README and setup.py Aug 15, 2019
@fatcat2 fatcat2 mentioned this pull request Aug 15, 2019
@fatcat2 fatcat2 requested a review from kurtisvg August 16, 2019 16:16
README.md Outdated Show resolved Hide resolved
Co-Authored-By: Christopher Wilcox <[email protected]>
@fatcat2 fatcat2 merged commit 5b02e80 into master Aug 16, 2019
@fatcat2 fatcat2 deleted the readme branch August 16, 2019 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants