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

Improve READMEs and "first steps" with the library #59

Open
levalleux-ludo opened this issue Apr 27, 2023 · 0 comments
Open

Improve READMEs and "first steps" with the library #59

levalleux-ludo opened this issue Apr 27, 2023 · 0 comments

Comments

@levalleux-ludo
Copy link
Member

levalleux-ludo commented Apr 27, 2023 •
edited
Loading

  • provide an example scene that uses the NPM package
  • add screenshots (MVFW 2023) in the README file so that people can see what they can do with the library
  • make READMEs clearer, considering the 2 types of user profiles:
    • those who want to USE boson-dcl (atm ./libary/README.md, seen in NPM package page)
    • those who want to contribute to it (atm ./README.md, seen in GH project homepage)
  • replace product UUIDS in the README with real product UUID in the staging env (at the moment they are testing product)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@levalleux-ludo