| 1 | apeman-ui
|
| 2 | ===========
|
| 3 |
|
| 4 |
|
| 5 | [![Build Status][my_travis_badge_url]][my_travis_url]
|
| 6 | [![Code Climate][my_codeclimate_badge_url]][my_codeclimate_url]
|
| 7 | [![Code Coverage][my_codeclimate_coverage_badge_url]][my_codeclimate_url]
|
| 8 | [![npm version][my_npm_budge_url]][my_npm_url]
|
| 9 |
|
| 10 | 'ui' command module for apeman.
|
| 11 |
|
| 12 |
|
| 13 | Installation
|
| 14 | ------------
|
| 15 |
|
| 16 | Install module via [npm][npm_url].
|
| 17 |
|
| 18 | ```bash
|
| 19 | # Install as local module.
|
| 20 | $ npm install apeman-ui --save
|
| 21 | ```
|
| 22 |
|
| 23 | Usage
|
| 24 | -----
|
| 25 |
|
| 26 | 1. Prepare an `Apemanfile.js`
|
| 27 | 2. Run the command.
|
| 28 |
|
| 29 | **Apemanfile.js**
|
| 30 | ```javascript
|
| 31 | /**
|
| 32 | * This is an example Apemanfile.js
|
| 33 | */
|
| 34 |
|
| 35 | "use strict";
|
| 36 |
|
| 37 | module.exports = {
|
| 38 | $pkg: {/*...*/},
|
| 39 | $ui: {
|
| 40 | // Setup distribution with directory path.
|
| 41 | 'vender/ap_ui_components': [
|
| 42 | require('apeman-ui-contrib-viewing')({
|
| 43 | 'color': '#38E'
|
| 44 | })
|
| 45 | ]
|
| 46 | }
|
| 47 | };
|
| 48 |
|
| 49 |
|
| 50 | ```
|
| 51 |
|
| 52 | **Run the command.**
|
| 53 | ```javascript
|
| 54 | /**
|
| 55 | * This an example for apeman ui command.
|
| 56 | */
|
| 57 |
|
| 58 | var ui = require('apeman-ui');
|
| 59 |
|
| 60 | ui('vender/ap_ui_components', {
|
| 61 | }, function (err) {
|
| 62 |
|
| 63 | });
|
| 64 | ```
|
| 65 |
|
| 66 | Options
|
| 67 | -------
|
| 68 |
|
| 69 | | Key | Description | Default |
|
| 70 | | --- | ----------- | ------- |
|
| 71 | | verbose | Show verbose logs | false |
|
| 72 | | configuration | Pathname of Apemanfile | |
|
| 73 |
|
| 74 |
|
| 75 | CLI
|
| 76 | ---
|
| 77 |
|
| 78 | apeman-ui also provides CLI(command line interface).
|
| 79 |
|
| 80 | ```bash
|
| 81 | # Install as global module for CLI usage.
|
| 82 | $ npm install apeman-ui --g
|
| 83 | ```
|
| 84 |
|
| 85 | Then,
|
| 86 |
|
| 87 | ```bash
|
| 88 | # Show help for CLI.
|
| 89 | $ apeman-ui -h
|
| 90 | ```
|
| 91 |
|
| 92 |
|
| 93 | License
|
| 94 | -------
|
| 95 |
|
| 96 | This software is released under the [MIT License][my_license_url].
|
| 97 |
|
| 98 |
|
| 99 | Links
|
| 100 | -----
|
| 101 |
|
| 102 | + [apeman][apeman_url]
|
| 103 |
|
| 104 |
|
| 105 | [npm_url]: https://www.npmjs.com/
|
| 106 | [apeman_url]: https://github.com/apeman-repo/apeman
|
| 107 | [my_repo_url]: https://github.com/apeman-repo/apeman-ui
|
| 108 | [my_travis_url]: http://travis-ci.org/apeman-repo/apeman-ui
|
| 109 | [my_travis_badge_url]: http://img.shields.io/travis/apeman-repo/apeman-ui.svg?style=flat
|
| 110 | [my_license_url]: https://github.com/apeman-repo/apeman-ui/blob/master/LICENSE
|
| 111 | [my_codeclimate_url]: http://codeclimate.com/github/apeman-repo/apeman-ui
|
| 112 | [my_codeclimate_badge_url]: http://img.shields.io/codeclimate/github/apeman-repo/apeman-ui.svg?style=flat
|
| 113 | [my_codeclimate_coverage_badge_url]: http://img.shields.io/codeclimate/coverage/github/apeman-repo/apeman-ui.svg?style=flat
|
| 114 | [my_npm_url]: http://www.npmjs.org/package/apeman-ui
|
| 115 | [my_npm_budge_url]: http://img.shields.io/npm/v/apeman-ui.svg?style=flat |
| \ | No newline at end of file |