y o g u r l

Author: 45kb

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+node_modules/

LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Filippo Oretti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,121 @@
+<p align="center">
+  <a href="http://yogurl.io">
+    <img width="250" src="http://i.imgur.com/i2aenJ7.png">
+  </a>
+  <p align="center">Easy urls for your files and code.</p>
+</p>
+
+###What's Yogurl?
+
+Yogurl is the simple command line tool for [Yogurl.io](https://yogurl.io)
+
+It can be used as a [CLI](#install-cli) or installed as [node dependencies](#node-usage) if you prefer.
+
+###Requirements
+
+Node.js v5+
+
+###Install CLI
+
+```html
+npm install -g yogurl
+```
+
+###CLI Usage
+
+```
+$ yogurl <source> [ext]
+```
+
+```source```: A valid [file](Accepted extensions and file types) path or code string
+
+```ext```: A valid [extension](Accepted extensions and file types) available
+
+####Yogurlify a file
+
+```bash
+$ yogurl path/to/file.js
+```
+
+####Yogurlify a code string
+
+```bash
+$ yogurl ".yogurl{ display:yogurl; }" css
+```
+
+###Node Usage
+
+####Installation
+
+```bash
+$ npm install yogurl --save
+```
+
+####Yogurlify a file
+
+```javascript
+const Yogurl = require('yogurl');
+
+Yogurl.upload('/path/to/file.json', 'json').then((data) => {
+  //file is ready
+  console.log(data);
+  console.log('File is ready at:', data.data);
+
+}).catch((err) => {
+  //error
+  console.log(err);
+});
+```
+
+####Yogurlify a code string
+
+```javascript
+const Yogurl = require('yogurl');
+
+Yogurl.upload("var x = 'yogurlify a javascript var';", 'js').then((data) => {
+  //file is ready
+  console.log(data);
+  console.log(`File is ready at: ${data.data}`);
+
+}).catch((err) => {
+  //error
+  console.log(err);
+});
+```
+
+###Available Output File Extensions
+`.js`
+
+`.css`
+
+`.scss`
+
+`.map`
+
+`.json`
+
+###Available Input File Extensions
+
+ANY (supposed)
+
+###Why Yogurl?
+
+Yogurl is born to help devs to get an url of their local ources (files or code) easily and as quick as possible.
+It is built for **development purposes**, it's not really recommended to use it in a production environment, **yogurl urls gets deleted after some time, so that you don't have to take care about them**.
+
+Since Yogurl is not backed by any sponsor or funds of any kind: we apologize for any trouble/problem/issue you could encounter.
+
+Please don't spam it and use it with moderation, Yogurl is your friend.
+
+###Contact Yogurl
+
+Feel free to open an issue or contact us on [twitter](http://twitter.com/720kb_)
+
+###Contributing
+
+We will be much grateful if you help us to grow and improve the project.
+Contribute by forking, opening issues, pull requests and whatever.
+
+###License
+
+[MIT](http://github.com/720kb/yogurl/#license.md)