Skip to content
This repository has been archived by the owner on Jan 1, 2025. It is now read-only.

docs: Update README.md #2030

Closed
wants to merge 1 commit into from

Conversation

nickscamara
Copy link

Suggestion to improve the README.md:

  • Add a small badge that prompts users to learn Recoil with an interactive example. This will help potential users to better understand the framework allowing them to try for themselves with a real use case (Todo list example) without leaving the web. The tutorial itself provides code walkthroughs and an interactive sandbox environment with the Todo list example from the original docs. If you would like to make edits to the example, ping me at [email protected].

Hope you like this add-on and would love any feedback.

Suggestion to improve the README.md: Add a small badge that prompts users to learn recoil with an interactive tutorial. This will help potential Recoil users to better understand the framework allowing them to try for themselves with a real use case (Todo list example) without leaving the web.
@facebook-github-bot
Copy link
Contributor

Hi @nickscamara!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 23, 2022
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@drarmstr drarmstr added the documentation Improvements or additions to documentation label Sep 23, 2022
@drarmstr
Copy link
Contributor

This looks really cool @nickscamara! It's something people have been asking about to have more interactive live code demos.

Though, badges on the project name aren't usually used like this and it's probably not the most obvious way for people to find the tutorial. Put up a couple PRs with @wd-fb to better link to this tutorial in the docs and readme if you want to review?

#2031

#2032

@nickscamara
Copy link
Author

Awesome! Thank you @drarmstr! I reviewed them and looks great.

@nickscamara
Copy link
Author

Closing this when #2031 #2032 get merged.

@drarmstr drarmstr closed this Oct 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants