Skip to content

Virtual whiteboard for sketching hand-drawn like diagrams

Adding readme (#83)

Faustino Kialungilaa6f154b36be3
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..56ba83cfe1
--- /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.