git » sdk » commit 6795b5e

README

author Stephen Paul Weber
2024-04-16 17:22:02 UTC
committer Stephen Paul Weber
2024-04-16 17:22:43 UTC
parent 643d06e251fcb5e36918ed0c5c67a662ce455723

README

README.md +19 -0

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c0d9179
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Snikket SDK
+
+Working towards simplicity in developing Snikket-compatible apps.
+
+    haxelib install datetime haxe-strings hsluv tink_http sha thenshim
+    make
+
+# JavaScript
+
+browser.js, though should also work on nodejs for the most part.
+Also some typings are generated which include documenation comments.
+
+# C
+
+libsnikket.so and cpp/snikket.h, the latter has documentation comments
+
+# Swift
+
+libsnikket.so and cpp/snikket.h are wrapped by cpp/Snikket.swift