Update README.md

This commit is contained in:
Christopher Chedeau 2020-01-03 18:19:58 -08:00 committed by GitHub
parent 85cd2f114a
commit aad99b3047
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,26 +1,26 @@
# Excalidraw
Excalidraw is a whiteboard tool that lets you easily sketch diagrams.
Excalidraw is a whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.
## Try it now
If you want to start sketching, please check https://excalidraw.com
### Excalidraw is built using these awesome tools
- [React](https://reactjs.org/)
- [Rough.js](https://roughjs.com/)
The project is at its early days, there are some key [features](https://github.com/excalidraw/excalidraw/milestone/1) that we need to implement in order to make the application very useful.
Go to https://excalidraw.com to start sketching
## Getting started
### Code Sandbox
- Go to https://codesandbox.io/s/github/excalidraw/excalidraw
- You can start coding instantly, and even send PRs from there!
### Local Installation
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Clone the repo
```bash
https://github.com/excalidraw/excalidraw.git
git clone https://github.com/excalidraw/excalidraw.git
```
Install all the dependencies
@ -38,3 +38,10 @@ npm run start
## Contributing
Pull requests are welcome. For major changes, please open an [issue](https://github.com/excalidraw/excalidraw/issues) first to discuss what you would like to change.
## Excalidraw is built using these awesome tools
- [React](https://reactjs.org/)
- [Rough.js](https://roughjs.com/)
The project is at its early days, there are some key [features](https://github.com/excalidraw/excalidraw/milestone/1) that we need to implement in order to make the application very useful.