feat/readme/add-files

CHANGELOG.md

@@ -1,4 +1,4 @@
-# [v1.0.0](https://github.com/MyScript/iinkJS/tree/v1.0.0)
+# [v1.0.0](https://github.com/MyScript/iinkTS/tree/v1.0.0)
 
 ## Features
-- migration javascript to typescript [link](https://github.com/MyScript/iinkJS)
+- migration javascript to typescript [link](https://github.com/MyScript/iinkTS)

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+We gladly welcome pull requests to iinkTS. If you have any questions, or need help to solve a problem, feel free to stop by the [MyScript forum](https://developer-support.myscript.com/support/discussions/forums/16000096021).
+
+## CLA
+
+In order to contribute, you must first agree to the **Contributor License Agreement** available [here](http://goo.gl/forms/YyzZ9VSvYG).
+
+Make sure you read the article "[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)" to understand the contributing process.

SETUP.md

@@ -0,0 +1,15 @@
+# Environment setup
+
+## Configure project
+
+1. Download sources
+2. Install dependencies.
+    * `npm install`
+3. Build the project using our npm script.
+    * `npm run build`
+4. Run the server and the live reload using our npm script.
+    * `npm run dev`. Examples will be available on `http://localhost:8000/examples/index.html`
+
+**Start coding**
+
+5. Debug using your favorite browser dev tools. The sources will be available under the webpack source folder (for chrome dev tools). Every change in sources will trigger a rebuild with linter and basic tests.