UNPKG

3.37 kBMarkdownView Raw
1apeman-brws-history
2==========
3
4<!---
5This file is generated by ape-tmpl. Do not update manually.
6--->
7
8<!-- Badge Start -->
9<a name="badges"></a>
10
11[![Build Status][bd_travis_shield_url]][bd_travis_url]
12[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
13[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
14[![npm Version][bd_npm_shield_url]][bd_npm_url]
15[![JS Standard][bd_standard_shield_url]][bd_standard_url]
16
17[bd_repo_url]: https://github.com/apeman-brws-labo/apeman-brws-history
18[bd_travis_url]: http://travis-ci.org/apeman-brws-labo/apeman-brws-history
19[bd_travis_shield_url]: http://img.shields.io/travis/apeman-brws-labo/apeman-brws-history.svg?style=flat
20[bd_travis_com_url]: http://travis-ci.com/apeman-brws-labo/apeman-brws-history
21[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-brws-labo/apeman-brws-history.svg?token=
22[bd_license_url]: https://github.com/apeman-brws-labo/apeman-brws-history/blob/master/LICENSE
23[bd_codeclimate_url]: http://codeclimate.com/github/apeman-brws-labo/apeman-brws-history
24[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-brws-labo/apeman-brws-history.svg?style=flat
25[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-brws-labo/apeman-brws-history.svg?style=flat
26[bd_gemnasium_url]: https://gemnasium.com/apeman-brws-labo/apeman-brws-history
27[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-brws-labo/apeman-brws-history.svg
28[bd_npm_url]: http://www.npmjs.org/package/apeman-brws-history
29[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-brws-history.svg?style=flat
30[bd_standard_url]: http://standardjs.com/
31[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
32
33<!-- Badge End -->
34
35
36<!-- Description Start -->
37<a name="description"></a>
38
39History manager for browser
40
41<!-- Description End -->
42
43
44<!-- Overview Start -->
45<a name="overview"></a>
46
47
48
49<!-- Overview End -->
50
51
52<!-- Sections Start -->
53<a name="sections"></a>
54
55<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->
56
57<a name="section-doc-guides-01-installation-md"></a>
58Installation
59-----
60
61```bash
62$ npm install apeman-brws-history --save
63```
64
65
66<!-- Section from "doc/guides/01.Installation.md.hbs" End -->
67
68<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->
69
70<a name="section-doc-guides-02-usage-md"></a>
71Usage
72---------
73
74```javascript
75'use strict'
76
77const apHistory = require('apeman-brws-history')
78
79// Push a history.
80apHistory.push('/user/profile')
81
82```
83
84
85<!-- Section from "doc/guides/02.Usage.md.hbs" End -->
86
87<!-- Section from "doc/guides/03.bundle.md.hbs" Start -->
88
89<a name="section-doc-guides-03-bundle-md"></a>
90Bundle
91------
92
93Use [browserify](http://browserify.org/) to bundle as client side script.
94
95```
96$ browserify main.js -o bundle.js
97```
98
99
100<!-- Section from "doc/guides/03.bundle.md.hbs" End -->
101
102
103<!-- Sections Start -->
104
105
106<!-- LICENSE Start -->
107<a name="license"></a>
108
109License
110-------
111This software is released under the [MIT License](https://github.com/apeman-brws-labo/apeman-brws-history/blob/master/LICENSE).
112
113<!-- LICENSE End -->
114
115
116<!-- Links Start -->
117<a name="links"></a>
118
119Links
120------
121
122+ [apeman][apeman_url]
123+ [browserify][browserify_url]
124
125[apeman_url]: https://github.com/apeman-labo/apeman
126[browserify_url]: http://browserify.org/
127
128<!-- Links End -->