Merge branch 'master' of github.com:algorithm-visualizer/tracers.js

64json · 64json · commit 696de9408663 · 2019-01-17T01:45:09.000-05:00
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# tracers.js
+
+> `tracers.js` is a visualization library for JavaScript.
+
+This repository is part of the project [Algorithm Visualizer](https://github.com/algorithm-visualizer).
+
+## Installation
+
+```bash
+npm install algorithm-visualizer
+```
+
+## Usage
+
+```js
+import { LogTracer } from 'algorithm-visualizer';
+
+const logTracer = new LogTracer('Scratch Paper');
+
+logTracer.print('Visualize your own algorithm here!');
+```
+
+Check out the [API reference](https://github.com/algorithm-visualizer/algorithm-visualizer/wiki) for more information.
+
+## Contributing
+
+Check out the [contributing guidelines](https://github.com/algorithm-visualizer/tracers.js/blob/master/CONTRIBUTING.md).
