Skip to content

Commit

Permalink
Add WHY section and some documentations about directories
Browse files Browse the repository at this point in the history
  • Loading branch information
fernahh committed Jun 8, 2016
1 parent d8eaa7c commit cd478a2
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
# CLI.js Boilerplate

> A boilerplate to build CLIs with JavaScript.
> A boilerplate to build CLIs with JavaScript. No transpilers, just JavaScript.
## Why?

CLIs are cool and useful. JavaScript is awesome and the [most popular programming language of world](http://stackoverflow.com/research/developer-survey-2016#technology). But, how to develop scalable and testable tools? What are the standards to be followed?

This project is a result of studies, based on experiencies and the [Unix Philosophy](https://en.wikipedia.org/wiki/Unix_philosophy).

## Getting started

You can get in two ways:
Choose a option:

1. [Clone the repo](https://github.com/fernahh/clijs-boilerplate.git) or...
2. Download last release as a [zip file](https://github.com/fernahh/clijs-boilerplate/archive/master.zip).
2. Download last [release](https://github.com/fernahh/clijs-boilerplate/archive/master.zip).

## Structure

The structure is simple:

```
├── bin/
│ └── app
├── doc/
│ └── help.txt
├── src/
| ├── helpers
| ├── helpers/
| | └── log-error.js
| ├── modules
| ├── modules/
| | └── help.js
│ └── app.js
├── test/
Expand All @@ -33,15 +41,15 @@ You can get in two ways:

### [bin/](https://github.com/fernahh/clijs-boilerplate/tree/master/bin/)

//todo
The Node.js packages are based on [CommonJS Packages/1.1](http://wiki.commonjs.org/wiki/Packages/1.1), and this specification says that executable files must be in the directory `/bin`.

### [doc/](https://github.com/fernahh/clijs-boilerplate/tree/master/doc/)

//todo
Keep the documentation in external files leaves more flexible, especially if it's large.

### [src/](https://github.com/fernahh/clijs-boilerplate/tree/master/src/)

//todo
The main modules, helpers a application file are here.

### [test/](https://github.com/fernahh/clijs-boilerplate/tree/master/test/)

Expand All @@ -55,17 +63,6 @@ You can get in two ways:

//todo


## Features

### Testable

//todo

### Based on [Unix Philosophy](https://en.wikipedia.org/wiki/Unix_philosophy)

//todo

## Maintainer

Luiz Fernando Rodrigues - http://fernahh.com.br
Expand Down

0 comments on commit cd478a2

Please sign in to comment.