Skip to content
This repository was archived by the owner on Aug 22, 2023. It is now read-only.

README.md cosmetic updates #59

Merged
Parent: release 0.6.4
merged 5 commits into from
Nov 18, 2022
Merged

README.md cosmetic updates #59

merged 5 commits into from
Nov 18, 2022

Conversation

@nh916
Copy link
Contributor

@nh916 nh916 commented Nov 15, 2022

added badges and made the links a bit cleaner

@nh916
README.md cosmetic updates
01f149c 
added badges and made the links a bit cleaner
@nh916 nh916 requested review from CVilla17 and dylanwal November 15, 2022 19:09
CVilla17
CVilla17 previously approved these changes Nov 16, 2022
View reviewed changes
brili
brili previously approved these changes Nov 16, 2022
View reviewed changes
@brili
Copy link
Contributor

brili commented Nov 16, 2022

is there a ticket for this?

@dylanwal
Copy link
Contributor

I like the badges!
Can we get CRIPT logo/image added to the README too?

I would suggest keeping the 'pip install' aspect of the README.
we should look to emulate : https://github.com/pandas-dev/pandas

@nh916
updated README.md to be a bit nicer as requested in the comments
667f111 
* added a colored logo with white background to the top

* Added more explanation about the Repo within the README.md
@nh916 nh916 dismissed stale reviews from brili and CVilla17 via 667f111 November 16, 2022 20:16
@nh916
Copy link
Contributor Author

nh916 commented Nov 16, 2022

@brili there is no ticket for this, I started working on the SDK and thought this is an improvement that I can make quickly and created a PR for it

@nh916
Copy link
Contributor Author

nh916 commented Nov 16, 2022

@dylanwal great suggestions! I implemented your suggestions. Please take a look at the README.md now and let me know what you think.

I agree the logo makes it look much better. I went with the purple version and removed the background to make it transparent which I think works better on both light and dark mode

@brili
Copy link
Contributor

brili commented Nov 17, 2022

@nh916 we need to restore the Prerequisites saying that python 3.9+ is required

@nh916
Copy link
Contributor Author

nh916 commented Nov 17, 2022 •
edited
Loading

@brili yeah I added that in one of the badges, but maybe thats not very clear since they're small, Ill write it in the installation section too

@nh916
updated license badge link, added python 3.9+ as a requirement in the…
1294d47 
… installation section

Adding python 3.9+ is required in the installation section
updated MIT license link
capitalizing Python everywhere to stay consistent
Updated alt text to make it more understandable
@brili brili merged commit b2f7528 into develop Nov 18, 2022
@brili brili deleted the update-readme branch November 18, 2022 15:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

3 more reviewers

@brili brili brili approved these changes

@dylanwal dylanwal dylanwal approved these changes

@CVilla17 CVilla17 CVilla17 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@nh916 @brili @dylanwal @CVilla17