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

Create README for SDK package #772

Closed
Tracked by #758
tidal opened this issue Jul 16, 2022 · 1 comment
Closed
Tracked by #758

Create README for SDK package #772

tidal opened this issue Jul 16, 2022 · 1 comment
Labels
bite sized This is a small chunk of work (good for new or time limited contributors!) documentation Improvements or additions to documentation good first issue Good for newcomers help wanted This issue is looking for someone to work on it package This issues is related to package (distribution)

Comments

@tidal
Copy link
Member

tidal commented Jul 16, 2022

The SDKpackage should have a README which explains its content, main components and at least give a rough overview over their usage. It also should link to the installation instructions of the main README.

@tidal tidal changed the title Create README for API package Create README for SDK package Jul 16, 2022
@tidal tidal added help wanted This issue is looking for someone to work on it bite sized This is a small chunk of work (good for new or time limited contributors!) package This issues is related to package (distribution) documentation Improvements or additions to documentation labels Jul 16, 2022
@bobstrecansky bobstrecansky added the good first issue Good for newcomers label Oct 12, 2022
@brettmc
Copy link
Collaborator

brettmc commented Apr 12, 2023

Completed.

@brettmc brettmc closed this as completed Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bite sized This is a small chunk of work (good for new or time limited contributors!) documentation Improvements or additions to documentation good first issue Good for newcomers help wanted This issue is looking for someone to work on it package This issues is related to package (distribution)
Projects
None yet
Development

No branches or pull requests

3 participants