Merge pull request #41 from Chhekur/master

update: documentation

Author: Chhekur

build/package.json

@@ -1,6 +1,6 @@
 {
   "name": "androidjs",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Android JS Is A Framework For Creating Android Applications With Web Technologies Like JavaScript, HTML, And CSS.",
   "main": "index.js",
   "scripts": {

docs/configuring_app.md

@@ -60,7 +60,7 @@ In order to change the **icon** of your app, you'll have to define `icon` attrib
 ```
 
 #### `Adding permissions to your android app`
-In order to add the android permissions, you will have to define an array of `permissions` in `package.json` file of your app
+In order to add the android permissions, you will have to define an array of `permissions` attribute in `package.json` file of your app
 
 ```json
 {
@@ -82,7 +82,7 @@ In order to add the android permissions, you will have to define an array of `pe
 you can find the permissions over android official [documentation](https://developer.android.com/guide/topics/permissions/overview)
 
 #### `Adding output directory`
-In order to add the output directory, you will have to define `dist-path` in `package.json` file of your app
+In order to add the output directory, you will have to define `dist-path` attribute in `package.json` file of your app
 
 ```json
 {
@@ -101,3 +101,30 @@ In order to add the output directory, you will have to define `dist-path` in `pa
   "license": "ISC"
 }
 ```
+
+#### `Define Project Type`
+In order to define project, you will have to define `project-type` attribute in `package.json` file of your app
+
+- `webview`
+  - if you are building `webview` based app or 'HTML / CSS' based
+- `react-native`
+  - if you are building `react native` based app
+
+```json
+{
+  "name": "myfirstapp",
+  "app-name" : "My First App",
+  "package-name": "myapp",
+  "permission": ["android.permission.INTERNET", "android.permission.SEND_SMS"],
+  "dist-path": "./dist",
+  "project-type":"webview",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC"
+}
+```

docs/generating_project.md

@@ -5,11 +5,10 @@
 Android JS enables you to create android applications with pure JavaScript by providing a runtime with rich native (android) APIs. You could see it as a variant of the Node.js runtime that is focused on android applications instead of web servers.
 
 ```sh
-mkdir myfirstapp
-cd myfirstapp
-androidjs g
+androidjs init
 npm install
 ```
+it will ask for `APP NAME` (i.e. myfirstapp)
 it will generate a sample project inside `myfirstapp`
 
 ```text

docs/index.md

@@ -8,6 +8,7 @@
   - [Change the icon of your app](configuring_app.md#change-the-icon-of-your-app)
   - [Adding permissions to your android app](configuring_app.md#adding-permissions-to-your-android-app)
   - [Adding output directory](configuring_app.md#adding-output-directory)
+  - [Define project type](configuring_app.md#define-project-type)
 - [Getting Started](getting_started.md)
 - [IPC (Inter Process Communication)](ipc.md)
   - [Back Module](ipc.md#back-module)