aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..5faf922
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+--- Haxe Tester ---
+
+A simple Haxe library for creating test cases.
+
+* Installation
+
+$ haxelib git haxe-tester https://git.rc-05.com/haxe-tester
+
+* Documentation
+
+The documentation is available at https://docs.rc-05.com/haxe-tester/git for the
+unstable git repository.
+
+* License
+
+This project is licensed with the MIT License which can be viewed by
+reading the LICENSE file supplied with this codebase.