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

64json · 64json · commit 7e2cc20b6436 · 2019-01-17T14:07:31.000-05:00
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# tracers.java
+
+> `tracers.java` is a visualization library for Java.
+
+This repository is part of the project [Algorithm Visualizer](https://github.com/algorithm-visualizer).
+
+## Installation
+
+1. Download `algorithm-visualizer.jar` in the [latest release](https://github.com/algorithm-visualizer/tracers.java/releases/latest).
+
+2. Add it to the classpath.
+
+## Usage
+
+```java
+import org.algorithm_visualizer.*;
+
+class Main {
+    public static void main(String[] args) {
+        LogTracer 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.java/blob/master/CONTRIBUTING.md).
