From a6f154b36be3b3bca40e86150d028d38c269b73b Mon Sep 17 00:00:00 2001 From: Faustino Kialungila Date: Sat, 4 Jan 2020 00:29:13 +0100 Subject: [PATCH] Adding readme (#83) --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..56ba83cf --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Excalidraw + +Excalidraw is a whiteboard tool that lets you easily sketch diagrams. + +## 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. + +## Getting started + +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 +``` + +Install all the dependencies + +```bash +npm install +``` + +Run the project + +```bash +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.