Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

light readme copyediting #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

light readme copyediting #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Emojize
High resolution, unicode (emoji) to html conversion utility
A high resolution, unicode (emoji) to html conversion utility.

``` sh
npm install emojize --save
Expand Down Expand Up @@ -33,7 +33,7 @@ document.getElementById('content').innerHTML = convert('Haay 😜')
```

### Sprite vs Image
`emojize` defaults to sprite based conversion which ultimately requires the developer to include the `sprite/emoji.css` and upload the `emoji.png` along side the file. You could otherwise include all images found in [`img/`](img/) and pass in flag to the second argument to `emojize`
`emojize` defaults to sprite-based conversion which ultimately requires the developer to include the `sprite/emoji.css` and upload the `emoji.png` alongside the file. You could otherwise include all images found in [`img/`](img/) and pass in flag to the second argument to `emojize`

``` js
var emo = require('emojize')
Expand All @@ -57,7 +57,7 @@ open http://localhost:3000/example.jade
![Screenshot](http://cl.ly/image/0L3I2y2v0A3D/Screen%20Shot%202014-05-03%20at%202.19.32%20PM.png)

### Sizing
Each emoji defaults to `64px` × `64px` which may not always be desired. Thus, consider the following practice. Example assumes LESS.
Each emoji defaults to `64px` × `64px` which may not always be desired. Thus, consider the following practice (example assumes LESS):

``` css
.quarter { zoom: 0.25 }
Expand Down