Update README.md
This commit is contained in:
parent
85cd2f114a
commit
aad99b3047
27
README.md
27
README.md
@ -1,26 +1,26 @@
|
|||||||
# Excalidraw
|
# 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
|
## Try it now
|
||||||
|
|
||||||
If you want to start sketching, please check https://excalidraw.com
|
Go to https://excalidraw.com to start sketching
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
## Getting started
|
## 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.
|
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
|
Clone the repo
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
https://github.com/excalidraw/excalidraw.git
|
git clone https://github.com/excalidraw/excalidraw.git
|
||||||
```
|
```
|
||||||
|
|
||||||
Install all the dependencies
|
Install all the dependencies
|
||||||
@ -38,3 +38,10 @@ npm run start
|
|||||||
## Contributing
|
## 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.
|
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.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user