Add README and LICENSE

Author: KidkArolis

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Karolis Narkevicius
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,45 @@
+# rescript-zed
+
+ReScript support for [Zed](zed.dev) editor.
+
+This extension plugs in the following projects:
+
+- [tree-sitter-rescript](https://github.com/rescript-lang/tree-sitter-rescript) parser
+- [@rescript/language-server](https://github.com/rescript-lang/rescript-vscode) LSP
+
+## Developing
+
+Zed and it's support for extensions is being actively developed. The current workflow that can be used to build this extension locally and install it into Zed is:
+
+Clone zed and build the `zed-extension` cli:
+
+    git clone git@github.com:zed-industries/zed.git
+    cd zed
+    cargo build --release --package extension_cli
+    ln -sf "$(pwd -P)/target/release/zed-extension" /usr/local/bin/zed-extension
+
+Build and install the extension locally
+
+    make build
+
+Tail zed logs
+
+    tail -f ~/Library/Logs/Zed/Zed.log
+
+After opening a ReScript file, open Cmd + Shift + P nav and find
+
+    language selector: toggle
+
+And to see the language server logs, open Cmd + Shift + P nav and find
+
+    debug: open language server logs
+
+## Known issues
+
+This is the a very early cut of this extension and I have noticed:
+
+- it's very slow to bring up autocomplete
+- the syntax partially loses highlighting as you're typing
+- the language server crashes quite easily and doesn't restart
+
+We'll look to work through all these issues in the future releases!