Skip to content

Commit

Permalink
update-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hyunguyen committed Jul 12, 2017
1 parent 6f6e307 commit ca9846f
Show file tree
Hide file tree
Showing 19 changed files with 54 additions and 12,047 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Quick start
* Clone the repo: `git clone [email protected]:foxieboy/dotstail.git`
* Install with npm: `npm install --save-dev dotstail`
* Or download the [latest release] (https://github.com//foxieboy/dotstail/archive/master.zip)
* Or download the [latest release](https://github.com//foxieboy/dotstail/archive/master.zip)

## How to use
In other to use dotstail:
Expand All @@ -15,7 +15,7 @@ In other to use dotstail:
dotstail.setDot ({
'element': '*your element class or id here*',
'letter': 0,
'lines': 4,
'lines': 4
});
```
* Please keep in mind: `letter`, and `line` option are optional, use them if you want to. Also those options must be a `number`, not `string`.
Expand All @@ -29,9 +29,15 @@ Call the function by `dotstail.setDot ();`
## Documentation
* `element`: is your element class/Id
* `letter`: is the number of letter you want to cut out at the end of the last line.
* `line`: is the number of line you want your element to have a `text elipsis` effect.

* `lines`: is the number of line you want your element to have a `text elipsis` effect.

## Tree
```
public/
└── theme/
└── js/
└── dotstail.min.js
```
## Template full feature list

* Semantically Correct / Valid HTML Code
Expand Down
Loading

0 comments on commit ca9846f

Please sign in to comment.