Worked on the Readme file. Added placeholder for later iterations. #42
Conversation
| ## Contributing | ||
|
|
||
| See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. | ||
|
|
||
| Join the [Community](https://discord.gg/ApuAzVnAaX) here! |
There was a problem hiding this comment.
please add a link to the documentation: https://cdiddy77.github.io/react-native-mediapipe/
There was a problem hiding this comment.
I added the documentation near the top since this one did that https://github.com/react-native-firebase/react-native/blob/master/README.md and it felt like something important to have near the top, should I move it down?
|
Overall, I would say: just be sure that the instructions you are providing actually work. If you haven't done part 2 of the rampup (follow the video in the link above) I would strongly encourage you to do so, since this will allow you to understand a lot better what is going on and thus to be able to verify that your README instructions are correct. |
did most of the changes, i need to add the documentation from the video later when I get back
fixed an oopsie
There was a problem hiding this comment.
@shackerman in the future please use a title that reflects the change you made, eg. "Updated README with correct instructions"
|
closes issue #3 |
Added placeholder text in a few places for things such as the documentation site, an example image of the program in use, and a banner up top.
My plan is to make the banner link to the discord server invite the way the following readme does it. https://github.com/mrousavy/react-native-vision-camera/blob/main/README.md