docs: update readme and add contributing file (#30)

* docs: update readme and add contributing file

* docs(readme): add contributing section

* chore: remove github semantic app

Author: bgrand-ch

.github/semantic.yml

@@ -0,0 +1,18 @@
+# Contributing
+
+ 1. **Fork** the repo on GitHub
+ 2. **Clone** the project to your own machine
+ 3. **Commit** changes to your own branch
+ 4. **Push** your work back up to your fork
+ 5. Submit a **Pull request** so that we can review your changes
+
+> Be sure to merge the latest from "upstream" before making a pull request!
+
+## How to run the project locally on your machine?
+
+1. Install dependencies in root folder, src folder and demo folder with `npm install` on each folder.
+2. Start an Android emulator or iOS simulator.
+3. From root folder, run `npm run dev` in a terminal tab.
+4. From root folder, run `npm run debug:android -- --path demo` (or `npm run debug:ios -- --path demo`) in another terminal tab.
+
+> You have to be careful with the update of dependencies, this can cause a certain number of errors, especially related to TypeScript.

CONTRIBUTING.md

@@ -1,9 +1,9 @@
 # NativeScript Getters Plugin
 
 ![NPM version](https://img.shields.io/npm/v/nativescript-getters)
-![GitHub last commit](https://img.shields.io/github/last-commit/bgrand-ch/nativescript-getters)
-![NPM downloads](https://img.shields.io/npm/dw/nativescript-getters)
 ![NPM bundle size](https://img.shields.io/bundlephobia/min/nativescript-getters)
+![NPM total downloads](https://img.shields.io/npm/dt/nativescript-getters)
+![GitHub last commit](https://img.shields.io/github/last-commit/bgrand-ch/nativescript-getters)
 
 A NativeScript plugin that adds six new getters – in addition to the native `getViewById` method – to retrieve one or more views by tag, type, class, property, value pair or style.
 
@@ -123,8 +123,6 @@ export function navigatingTo(args: EventData) {
 
 The list of possible property names can be found on the [view page](https://v7.docs.nativescript.org/api-reference/classes/view.html) of the NativeScript API documentation.
 
-> Note: The color name (example: red or white) is converted by NativeScript to hexadecimal.
-
 #### Get views by val pairs
 
 ```typescript
@@ -163,6 +161,8 @@ export function navigatingTo(args: EventData) {
 }
 ```
 
+> Note: The color name (example: red or white) is converted by NativeScript to hexadecimal.
+
 The list of possible styles can be found on the [style page](https://v7.docs.nativescript.org/api-reference/classes/style.html) of the NativeScript API documentation.
 
 ### Example in stand-alone mode
@@ -239,6 +239,10 @@ If you have a question about how `nativescript-getters` works or an idea to impr
 
 However, if you get an error, you should open an [issue](https://github.com/bgrand-ch/nativescript-getters/issues).
 
+## Contributing
+
+See [CONTRIBUTING](https://github.com/bgrand-ch/nativescript-getters/blob/main/CONTRIBUTING.md) for more information.
+
 ## License
 
 Distributed under the MIT License. See [LICENSE](https://github.com/bgrand-ch/nativescript-getters/blob/main/LICENSE.md) for more information.

README.md

@@ -16,10 +16,10 @@
   },
   "devDependencies": {
     "@nativescript/eslint-plugin": "0.0.4",
-    "commitizen": "4.2.4",
+    "commitizen": "4.2.5",
     "cz-conventional-changelog": "3.3.0",
     "eslint": "7.26.0",
-    "nativescript": "8.0.1",
-    "standard-version": "9.3.0"
+    "nativescript": "8.3.3",
+    "standard-version": "9.5.0"
   }
 }