angular2-shave - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

		{
		"name": "angular2-shave",
		"version": "1.0.0",
		"version": "1.0.1",
		"main": "dist/index.js",
		@@ -5,0 +5,0 @@ "description": "A modern javascript plugin for truncating text within a html element",

README.md

		@@ -1,21 +0,15 @@
		# Angular 2 package starter
		# Angular 2 shave

		Easy to use package starter for Angular 2. Create open source modules/directive/components/pipes.
		Helps to create NPM package and publish it easily.
		Angular 2 directive for the [shave](https://dollarshaveclub.github.io/shave/) library - A modern javascript plugin for truncating text within a html element.

		## Installation
		- clone this repository
		- run one of the following commands:
		- `npm install`
		- `yarn install`
		`npm install angular2-shave --save`

		## Run tests
		`npm test`
		## Usage
		```html
		<div [shave]="{character: '✁', classname: 'myclass' }" [shaveHeight]="200">Lorem ipsum dolor sit amet, consectetur adipisicing elit. Asperiores consequuntur deserunt dolore dolores ea esse expedita, recusandae sint totam velit. Beatae deserunt expedita, laborum nobis placeat quibusdam recusandae similique sit!</div>
		```

		## Publishing package
		- describe your module well in README.md and bump version
		- run `npm publish`


		## License
		The repository code is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).

New alerts