Skip to content

Commit

Permalink
fix docs | update readme | publish v2
Browse files Browse the repository at this point in the history
  • Loading branch information
artemsky committed Jul 11, 2017
1 parent 02af394 commit 47bff2e
Showing 9 changed files with 39 additions and 22 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -17,3 +17,4 @@ install:
- npm install
script:
- npm run lib:build
- npm run example:test
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -52,6 +52,7 @@ MIT © [artemsky](mailto:[email protected])
- rewrite components. Now more optimized. Divided into separate components.
- Optimized for AOT build in right way.
- rewrite [documentation](documentation)
- add few test in example app
- update dependencies
- Auto-documentation add - Interfaces (thx @compodoc/compodoc)
- Auto-documentation add - Default values (thx @compodoc/compodoc)
@@ -107,7 +108,3 @@ You can see an example of custom icon by calling *Simple toast* in the example a
### v1.0.0

- First release

## Future

- rename component to `ng2-snotify` due semantic purpose
39 changes: 29 additions & 10 deletions docs/documentation/index.html
Original file line number Diff line number Diff line change
@@ -403,24 +403,47 @@ <h2 id="example">Example</h2>
<p><a href="https://artemsky.github.io/ng-snotify/">https://artemsky.github.io/ng-snotify/</a></p>
<h2 id="features">Features</h2>
<ul>
<li>8 types of toast notifications</li>
<li>Flexible, Configurable</li>
<li>8 types of toast notifications (async, confirm, prompt and more...)</li>
<li>Many config options (icons, backdrop, timeout, position and much more)</li>
<li>Custom styling</li>
<li>Lifecycle callbacks</li>
<li>Fully CSS, no angular animations dependency!</li>
<li>Custom css animations</li>
<li>Callbacks</li>
</ul>
<p><img src="https://github.com/artemsky/ng-snotify/blob/master/example/assets/ng-snotify.gif" alt="Snotify Gif" class="img-responsive"></p>
<hr>
<h2 id="installation">Installation</h2>
<h6 id="npm-5">NPM 5</h6>
<p><code>npm install ng-snotify</code></p>
<h6 id="yarn">yarn</h6>
<p><code>yarn add ng-snotify</code></p>
<p>Detailed instruction - <a href="https://github.com/artemsky/ng-snotify/wiki/Install">here</a></p>
<h2 id="documentation-and-examples">Documentation and Examples</h2>
<p>Wiki - <a href="https://github.com/artemsky/ng-snotify/wiki">here</a><br>Examples - <a href="https://github.com/artemsky/ng-snotify/wiki/Examples">here</a><br>Example application source - <a href="https://github.com/artemsky/ng-snotify/tree/master/example/app">here</a><br>Auto-Documentation - <a href="https://artemsky.github.io/ng-snotify/documentation/injectables/SnotifyService.html">here</a><br>Development - <a href="https://github.com/artemsky/ng-snotify/wiki/Development">here</a></p>
<p>Documentation - <a href="documentation">here</a><br>Example application source - <a href="https://github.com/artemsky/ng-snotify/tree/master/example/app">here</a><br>Auto-Documentation - <a href="https://artemsky.github.io/ng-snotify/documentation/index.html">here</a> </p>
<h2 id="license">License</h2>
<p>MIT © <a href="mailto:[email protected]">artemsky</a></p>
<h2 id="change-log">Change Log</h2>
<h3 id="v2-0-0">v2.0.0</h3>
<ul>
<li><strong>Breaking changes -</strong> <a href="documentation/v1-to-v2-migration-guide.md">Look migration guide</a></li>
<li><strong>Features</strong><ul>
<li>Now unlimited amount of buttons.</li>
<li>New <a href="documentation/v2/api.md#callbacks">callback</a> <code>onInput</code> for <strong>prompt</strong> toast</li>
<li>reduce start code amount</li>
<li>add custom <a href="documentation/v2/animations.md">animations</a></li>
</ul>
</li>
<li><strong>Fixes</strong><ul>
<li>rewrite components. Now more optimized. Divided into separate components.</li>
<li>Optimized for AOT build in right way.</li>
<li>rewrite <a href="documentation">documentation</a></li>
<li>add few test in example app</li>
<li>update dependencies<ul>
<li>Auto-documentation add - Interfaces (thx @compodoc/compodoc)</li>
<li>Auto-documentation add - Default values (thx @compodoc/compodoc)</li>
</ul>
</li>
</ul>
</li>
</ul>
<h3 id="v1-4-0">v1.4.0</h3>
<ul>
<li>add backdrop (<a href="https://github.com/artemsky/ng-snotify/issues/15">#15</a>)</li>
@@ -471,10 +494,6 @@ <h3 id="v1-0-0">v1.0.0</h3>
<ul>
<li>First release</li>
</ul>
<h2 id="future">Future</h2>
<ul>
<li>rename component to <code>ng2-snotify</code> due semantic purpose </li>
</ul>



4 changes: 2 additions & 2 deletions docs/documentation/js/search/search_index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!doctype html><html><head><meta charset="utf-8"><title>NgSnotify</title><meta name="description" content="Angular 2 Notification Center"><base href="/ng-snotify/"><!-- Schema.org markup for Google+ --><meta itemprop="name" content="NgSnotify"><meta itemprop="description" content="Angular 2 Notification Center"><meta itemprop="image" content="http://www.example.com/image.jpg"><!-- Twitter Card data --><meta name="twitter:site" content="https://artemsky.github.io/ng-snotify/"><meta name="twitter:title" content="NgSnotify"><meta name="twitter:description" content="Angular 2 Notification Center"><!-- Twitter summary card with large image must be at least 280x150px --><meta name="twitter:image:src" content="https://artemsky.github.io/ng-snotify/assets/preview.jpg"><!-- Open Graph data --><meta property="og:title" content="NgSnotify"/><meta property="og:type" content="article"/><meta property="og:url" content="https://artemsky.github.io/ng-snotify/"/><meta property="og:image" content="https://artemsky.github.io/ng-snotify/assets/preview.jpg"/><meta property="og:description" content="Angular 2 Notification Center"/><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" type="image/x-icon" href="favicon.ico"><link href="styles.b3c1e0f9c6a3753d12be.bundle.css" rel="stylesheet"/></head><body><app-root>Loading...</app-root><script type="text/javascript" src="inline.6b13a609478c9ce3875b.bundle.js"></script><script type="text/javascript" src="polyfills.a6c702235f67f49ab7be.bundle.js"></script><script type="text/javascript" src="vendor.13f5557059b318893460.bundle.js"></script><script type="text/javascript" src="main.5a6c192aea71896f2651.bundle.js"></script></body></html>
<!doctype html><html><head><meta charset="utf-8"><title>NgSnotify</title><meta name="description" content="Angular 2 Notification Center"><base href="/ng-snotify/"><!-- Schema.org markup for Google+ --><meta itemprop="name" content="NgSnotify"><meta itemprop="description" content="Angular 2 Notification Center"><meta itemprop="image" content="http://www.example.com/image.jpg"><!-- Twitter Card data --><meta name="twitter:site" content="https://artemsky.github.io/ng-snotify/"><meta name="twitter:title" content="NgSnotify"><meta name="twitter:description" content="Angular 2 Notification Center"><!-- Twitter summary card with large image must be at least 280x150px --><meta name="twitter:image:src" content="https://artemsky.github.io/ng-snotify/assets/preview.jpg"><!-- Open Graph data --><meta property="og:title" content="NgSnotify"/><meta property="og:type" content="article"/><meta property="og:url" content="https://artemsky.github.io/ng-snotify/"/><meta property="og:image" content="https://artemsky.github.io/ng-snotify/assets/preview.jpg"/><meta property="og:description" content="Angular 2 Notification Center"/><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" type="image/x-icon" href="favicon.ico"><link href="styles.b3c1e0f9c6a3753d12be.bundle.css" rel="stylesheet"/></head><body><app-root>Loading...</app-root><script type="text/javascript" src="inline.7e08e8c648d75e8ec5cf.bundle.js"></script><script type="text/javascript" src="polyfills.a6c702235f67f49ab7be.bundle.js"></script><script type="text/javascript" src="vendor.13f5557059b318893460.bundle.js"></script><script type="text/javascript" src="main.0ace8cba010b5d5ff19d.bundle.js"></script></body></html>

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion documentation/v2/custom-styling.md
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ One changeable thing here is `.snotify-simple` where **simple** is the type of a
So you can swap it to change toast type target.

> **Important! Types are lowercase**
> You can find all types in [SnotifyType](https://github.com/artemsky/ng-snotify/wiki/Enums#snotifytype) interface
> You can find all types in [SnotifyType](api.md#snotifytype) interface
All types has the same structure except **prompt**. Because it has no progress bar

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "ng2-snotify",
"name": "ng-snotify",
"description": "Angular 2 notifications center",
"version": "2.0.0",
"scripts": {
@@ -21,7 +21,7 @@
"lint": "tslint --type-check -p src/tsconfig.es5.json src/**/*.ts",
"test": "tsc && karma start",
"lib:lint": "npm run lint && npm run example:lint",
"lib:build": "npm run example:test && npm run lib:lint && npm run build && npm run link:dist && npm run example:build:prod && npm run docs"
"lib:build": "npm run lib:lint && npm run build && npm run link:dist && npm run example:build:prod && npm run docs"
},
"repository": {
"type": "git",

0 comments on commit 47bff2e

Please sign in to comment.