From 64e2caf435b25397b888cf45d979fa2bb0e284e9 Mon Sep 17 00:00:00 2001 From: Sputnik Date: Thu, 19 Oct 2017 00:36:08 +1100 Subject: [PATCH] Update README and bump version --- README.md | 34 ++++++++++++++++++++++++++++++++++ package.json | 2 +- 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5276ea0..3ceca6b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Made With X Made with literally anything but love +## Use in browser + Drop this in your page just before `` ```html @@ -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": "🌈" +} +``` diff --git a/package.json b/package.json index 5c5b6ef..6d54ce7 100644 --- a/package.json +++ b/package.json @@ -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": {