Yogurl NPM | npm.io

###What's Yogurl?

Yogurl is the simple command line tool for Yogurl.io

It can be used as a CLI or installed as Node dependency if you prefer.

###Requirements

Node.js v5+

###Install CLI

npm install -g yogurl

###CLI Usage

$ yogurl <source> [ext]

source: A valid file path or code string

ext: A valid output extension available

####Yogurlify a file

$ yogurl path/to/file.js

####Yogurlify a file to new extension

$ yogurl path/to/file.txt js

####Yogurlify a code string

$ yogurl ".yogurl{ display:yogurl; }" css

###Node Usage

####Installation

$ npm install yogurl --save

####Yogurlify a file

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

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

.... and others to come!

###Available Input File Extensions

ANY (supposed)

###Why Yogurl?

Yogurl has been developed with one simple goal: urlify code and files 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 that could eventually happen.

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 or come chat on Gitter

###Contributing

We are much grateful if you help us to grow and improve the project. Contribute by forking, opening issues, pull requests or whatever.

###License

MIT