Skip to content

Add badges to Readme#307

Closed
peleccom wants to merge 2 commits into
getsentry:masterfrom
peleccom:feature/add-badges
Closed

Add badges to Readme#307
peleccom wants to merge 2 commits into
getsentry:masterfrom
peleccom:feature/add-badges

Conversation

@peleccom
Copy link
Copy Markdown

Add pypi package version badge
Add package licence Badge

@peleccom peleccom force-pushed the feature/add-badges branch from 194a6ee to 3c5f583 Compare March 27, 2019 00:08
@untitaker
Copy link
Copy Markdown
Member

If you think some information is missing from the README I would suggest to add regular links. My experience with them is that their text is cryptic and that they impact page load perf.

@peleccom
Copy link
Copy Markdown
Author

You could add just pypi version badge only to be aligned with sdk package for other languages, python-raven had this information too.

Currently, Readme file of this repository is poor. There are no module usage examples. No current version information. The first impression was it is not usable at all.

@untitaker
Copy link
Copy Markdown
Member

@peleccom Thanks for the feedback. I didn't want to duplicate information found elsewhere. I will add a small example though and I agree the current version does make sense to show.

@untitaker
Copy link
Copy Markdown
Member

trying to figure out what to do here:

  • I actually like the version badge now
  • https://sentry.io/for/python/ is the perfect readme for the sdk, but I don't know if I should just copypaste it into the code. Problem is that for each framework you need to do more things, so the basic example without integrations is often useless

@untitaker untitaker closed this in c891674 Apr 3, 2019
@untitaker
Copy link
Copy Markdown
Member

Thanks for your input, I think the README should be good now. I am still not sure if this will be misleading as a user often has to set up integrations to see anything.

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.

2 participants