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.

Sign up for GitHub

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

Jump to bottom

JS-SDK README cleanup/writeup/contribution #705

Open
a1ttech opened this issue Oct 25, 2024 · 4 comments
Open

JS-SDK README cleanup/writeup/contribution #705

a1ttech opened this issue Oct 25, 2024 · 4 comments
Labels
good first issue Good for newcomers Scout Game: Beginner

Comments

@a1ttech
Copy link
Contributor

a1ttech commented Oct 25, 2024 •
edited by Ansonhkg
Loading

Overview

Verify that the content in the README.md is accurate by ensuring that everything included works as expected.

Acceptance Criteria

Go through each package and rewrite any sections that are missing a short description. If there's already a description, just make sure it’s clear.

Low hanging fruit: UMD/Vanilla JS is not currently supported so that section needs to be removed.
@phoenixx11
Copy link

interested in this issue

@Chirag-S-Kotian
Copy link

assign this to me.

@Ansonhkg
Copy link
Collaborator

Hey @phoenixx11 @Chirag-S-Kotian feel free to get started and open a PR when you're done! We will review and merge it if everything is ok! :)

@phoenixx11
Copy link

my PR is ready for review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers Scout Game: Beginner
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Ansonhkg @a1ttech @phoenixx11 @Chirag-S-Kotian