search

pyodide / webtypy

Python type definitions for web APIs
Mozilla Public License 2.0
13 stars 3 forks source link

Improving readme #7

Open rth opened 1 year ago

rth commented 1 year ago

I just had a look at the readme, and I think it could use some updates keeping in mind the target audience.

Correct me if I'm wrong, but I think users would be mostly interested in,

  1. what this is: the first paragraph is OK

  2. how to use it: right now it's not clear to me how to use this from the readme

    As to the detailed generation process, well it's interesting but pretty technical and so maybe not something users need to be aware at first.

Also, some CI with a badge in the readme would really add confidence that this is a maintained project that can be relied on (speaking as a user).

Thanks for working on this project :)

simonegiacomelli commented 1 year ago

Hey Roman, thanks for taking the time and interest about this.

I completely agree, again thanks for the pointers! I will start with points 1, 2 and then on the badges. Any contribution is obviously welcome but I will spend time on it in the next couple of weeks (I hope).

fyi I did some research and spelunking about adding docs/platform support and I found something interesting on which I will work on too.

hoodmane commented 1 year ago

I've been intending to get to helping out with this @simonegiacomelli but I haven't quite gotten around to it yet...

simonegiacomelli commented 1 year ago

I just updated the README.md. It was a three hands work along with ChatGPT-4 (it's really amazing both with content and code!)

Please let me know if you have suggestions or feedback.

ryanking13 commented 1 year ago

Very cool! Thanks for your continued work.

It would be nice if there is a guide on how users (potential contributors) can build .pyi file locally from this repository.