search

C-Accel-CRIPT / sdk-archive

CRIPT Python SDK
MIT License
11 stars 0 forks source link

README.md cosmetic updates #59

Closed nh916 closed 1 year ago

nh916 commented 1 year ago

added badges and made the links a bit cleaner

brili commented 1 year ago

is there a ticket for this?

dylanwal commented 1 year ago

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 commented 1 year ago

@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 commented 1 year ago

@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 commented 1 year ago

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

nh916 commented 1 year ago

@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