Skip to content

Commit

Permalink
Merge pull request #14 from cix-cdx/dev
Browse files Browse the repository at this point in the history
to master
  • Loading branch information
tpanitte committed Jan 26, 2018
2 parents c5c7efb + bb4f0c7 commit c9a2e05
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This **cix-lic** modules can license a project via several capabilities.

- **CLI** - Command Line
- **CI** - Continuous Integration
- **API** - Application Program Interface

#### LIC Properties

Expand All @@ -21,13 +22,17 @@ Before we use **cix-lic**, it's important to know what properties are used. It's

- **endYear** | **-e** - the **declarative end year** - _default: "Present"_

- **proc** | **-p** - the **process** - _default: ["lic", "file"]_

- **baseDir** | **-d** - the **directory** where to query files - _default: root source directory_

- **filter** | **-f** - the **file filter** can be **string**, **RegExp**, or **{ test: () => _boolean_ }** - _default: *.js_

- **licFile** | **-i** - the specfied **lic file** (file header) - _default: undefined_
- **HFLcontent** | **-h** - the **Head File License Content** (file header content) - _default: undefined_

- **licenseContent** | **-c** - the **License Content** (license content) - _default: undefined_

- **licenseFile** | **-c** - the specfied **license file** (package) - _default: undefined_
- **licenseFile** - the **License File** (license file) - _default: ./LICENSE_

### CLI - Command Line

Expand Down Expand Up @@ -69,11 +74,11 @@ Then, we can run **cix-lic** script in **CI Process**.

### CIX-LIC Command

**Command Tags** are [**LIC Properties**](#lic-properties) and two tags, **conf** and **proc**.
**Command Tags** are [**LIC Properties**](#lic-properties)

**Examples**

cix-lic -o Jane Smith -l mit >> _owner_: **Jane Smith**, _lic_: **MIT License**
cix-lic **-o** _Jane Smith_ **-l** _mit_ >> **owner**: _Jane Smith_, **lic**: _MIT License_

cix-lic -l apache-2.0 -d ./lib >> _lic_: **Apache License 2.0**, _baseDir_: **./lib**
cix-lic **-d** _./lib_ **-l** _apache-2.0_ >> **baseDir**: _./lib_, **lic**: _Apache License 2.0_

0 comments on commit c9a2e05

Please sign in to comment.