Skip to content

Commit

Permalink
Update README and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
Dermah committed Oct 18, 2017
1 parent 054afb8 commit 64e2caf
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Made With X
Made with literally anything but love

## Use in browser

Drop this in your page just before `</body>`

```html
Expand All @@ -14,3 +16,35 @@ Then drop anything except love in to your page by using
```

This drops an emoji in to the page so your browser will have to support that.

## Use package

Install with one of:
```shell
yarn add made-with-x
```
```shell
npm install made-with-x
```

Then import with one of:
```js
import getX from 'made-with-x';
```
```js
var getX = require('made-with-x');
```

Then drop anything except love in using
```js
getX().emoji
```
`getX()` returns an object with this shape:
```JSON
{
"name": "rainbows",
"alt_text": "rainbows",
"emoji_unicode": "1F308",
"emoji": "🌈"
}
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "made-with-x",
"version": "0.1.0",
"version": "0.2.0",
"description": "Made with literally anything but love",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 64e2caf

Please # to comment.