Skip to content

Commit 303c849

Browse files
author
deveshpankaj
committed
Included README.md file
1 parent 36acef3 commit 303c849

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Androidjs-builder
2+
---
3+
This is official builder for creating [Androidjs](https://android-js.github.io/) apps. Builder provides required commands for creating Androidjs project and to build the project and generate Apk for [android](https://developer.android.com/about) devices.
4+
5+
## Installing from [npm](https://www.npmjs.com/). [![androidjs-builder][androidjs-builder-badge]][androidjs-builder-npm]
6+
```bash
7+
$ npm install -g androidjs-builder
8+
```
9+
This command installs the builder in globelly and sets the required commands.
10+
11+
## Creating Project.
12+
```bash
13+
$ androidjs init
14+
```
15+
This command is used for generating new project in the current directory. This command prompts for [``project-name``](https://android-js.github.io/docs/configuring_app.html#change-the-name-of-your-app) and [``project-type``](https://android-js.github.io/docs/configuring_app.html#define-project-type). Currently it supports only the HTML type project.
16+
17+
## Build project
18+
```bash
19+
$ androidjs build
20+
```
21+
This command is used to build project and generate Apk file. It can be used to build all type of projects supported by Androidjs.
22+
23+
24+
[androidjs-builder-badge]: https://img.shields.io/badge/Androidjs-builder-green.svg
25+
[androidjs-builder-npm]: https://www.npmjs.com/package/androidjs-builder
26+
[androidjs-builder-github]: https://github.com/android-js/androidjs-builder

src/bin.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ commander.version(pkg.version, '-v, --version')
5151

5252

5353
commander
54-
.command('create')
55-
.alias('c')
54+
.command('init')
5655
.description('Create new project')
5756
.option('-f, --force-build', 'Build force')
5857
.option('-d, --debug', 'Enable debug')

0 commit comments

Comments
 (0)