More documentation for newbies
See original GitHub issueHi. Thanks for your great work. I’m fairly new to React and I want to use this library for one of my project. I run the below command and everything has been installed successfully.
npm install react-image-annotate
But here is the problem. I don’t know how/where to use these lines to run the editor:
import ReactImageAnnotate from "react-image-annotate"
const App = () => (
<ReactImageAnnotate
selectedImage="https://example.com/image1.png"
taskDescription="# Draw region around each face\n\nInclude chin and hair."
images={[{ src: "https://example.com/image1.png", name: "Image 1" }]}
regionClsList={["Man Face", "Woman Face"]}
/>
)
Any help would be appreciated. Thanks.
Issue Analytics
- State:
- Created 4 years ago
- Comments:6 (3 by maintainers)
Top Results From Across the Web
A beginner's guide to writing documentation - Write the Docs
This is a guide to documenting your first project. ... Writing documentation is a different form of writing than most people have experience...
Read more >8 Tips to Reading Documentation: A Newbie's Guide in 2021
When reading documentation online, printed reference books can help clarify concepts. Use multiple sources. Technical documentation is not always written with ...
Read more >Code Documentation: A Guide for Beginner's
In this blog we'll be having a quick look into how to document the code. Before we get into how to... Tagged with...
Read more >Beginner's Guide to Documentation: Here's What You Need to ...
Beginner's Guide to Documentation: Here's What You Need to Know. We all use software. And we all learn - to some degree -...
Read more >How to Write a Good Documentation: Home
How to Write a Good Documentation: Home. This guide will help you to prepare your code for publishing through writing a good documentation....
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@ameer I introduced some additional documentation in 357beae to the README that I hope helps you understand how you can manipulate react-image-annotate for your application.
You’ll need to define the
onExit
function. What do you want to do with the output? If you want to save it, you’ll need to save it somewhere. Many people save to the cloud, some save to local storage.The warning is a minor issue, nothing to worry about.