docs

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+## Development Workflow
+
+- Run `npm run setup` to install deps and transpile source.
+- Run `npm run demo.ios` for iOS or `npm run demo.android` for Android
+- Make changes to plugin src directory or the demo app and HMR (webpack NS work flow) should sync changes.
+
+## Submitting Pull Requests
+
+**Please follow these basic steps to simplify pull request reviews - if you don't you'll probably just be asked to anyway.**
+
+- Please rebase your branch against the current master
+- Make reference to possible [issues](https://github.com/nstudio/nativescript-cardview/issues) on PR comment
+
+## Submitting bug reports
+
+- Please detail the affected platform and version
+- Please be sure to state which version of node, npm, and NativeScript you're using

README.md

@@ -223,6 +223,23 @@ shadowRadius = 1;
 | --------------------------------------- | --------------------------------------- |
 | ![Sample1](images/sample_card1_ios.png) | ![Sample2](images/sample_card3_ios.png) |
 
+## Run Demo
+
+```bash
+git clone https://github.com/nstudio/nativescript-cardview.git
+cd nativescript-cardview/src && npm run setup
+
+npm run demo.ios
+
+// or...
+
+npm run demo.android
+```
+
+## [Changelog](./CHANGELOG.md)
+
+## [Contributing](./CONTRIBUTING.md)
+
 #### Contributors
 
 | [<img alt="bradmartin" src="https://avatars3.githubusercontent.com/u/6006148?v=3&s=117" width="117">](https://github.com/bradmartin) | [<img alt="NathanWalker" src="https://avatars1.githubusercontent.com/u/457187?v=3&s=117" width="117">](https://github.com/NathanWalker) | [<img alt="manijak" src="https://avatars3.githubusercontent.com/u/3605066?v=3&s=117" width="117">](https://github.com/manijak) | [<img alt="NathanaelA" src="https://avatars0.githubusercontent.com/u/850871?v=3&s=117" width="117">](https://github.com/NathanaelA) | [<img alt="EddyVerbruggen" src="https://avatars2.githubusercontent.com/u/1426370?v=3&s=117" width="117">](https://github.com/EddyVerbruggen) | [<img alt="sis0k0" src="https://avatars1.githubusercontent.com/u/7893485?v=3&s=117" width="117">](https://github.com/sis0k0) |

publish/pack.sh

@@ -22,7 +22,7 @@ pack() {
 
     # copy README & LICENSE to src
     echo 'Copying README and LICENSE to /src...'
-    node_modules/.bin/ncp "$ROOT_DIR"/LICENSE "$TO_SOURCE_DIR"/LICENSE
+    node_modules/.bin/ncp "$ROOT_DIR"/LICENSE "$TO_SOURCE_DIR"/LICENSE.md
     node_modules/.bin/ncp "$ROOT_DIR"/README.md "$TO_SOURCE_DIR"/README.md
 
     # compile package and copy files required by npm

src/package.json

@@ -21,7 +21,8 @@
     "setup": "npm i && tsc",
     "demo.ios": "cd ../demo && tns run ios",
     "demo.android": "cd ../demo && tns run android",
-    "ci.tslint": "npm i && tslint '**/*.ts' --config '../tslint.json' --exclude '**/node_modules/**'"
+    "ci.tslint": "npm i && tslint '**/*.ts' --config '../tslint.json' --exclude '**/node_modules/**'",
+    "make-changelog": "cd ../ && github_changelog_generator -u nstudio -p nativescript-cardview --token=5271dafe824473addebf5951888d904c36164b0b"
   },
   "lint-staged": {
     "**/*.{js, css, ts, json, scss, html, xml, md}": [