Skip to content
This repository has been archived by the owner on Jun 4, 2024. It is now read-only.

Commit

Permalink
Publish 1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bokub committed Oct 15, 2018
1 parent b4b639f commit a4ea4ec
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Lyo](https://i.imgur.com/nt5bYNJ.png)](https://github.com/bokub/lyo/issues/1)
![Lyo](https://user-images.githubusercontent.com/17952318/44954822-2055cc80-aea9-11e8-9ebd-b10619f80171.png)

> Node.js to browser - The easy way
Expand Down Expand Up @@ -65,7 +65,15 @@ $ lyo --help
```


## Recommended workflow
## Tips

- Add a `.babelrc` file at the root of your project to [configure][babel-config] the Babel compilation step
- The bundle is supposed to run in browsers. A bundle used in a Node.js program will probably be slower than the original module
- Don't blame Lyo if it fails to compile your code. The error could come from [Browserify][browserify], [Babel][babel] or [UglifyJS][uglify]
- If you like Lyo, you will love [lyo.now.sh](https://lyo.now.sh/), an automated bot 🤖 running Lyo on npm modules of your choice


## Using Lyo on your own module

Once you've tried Lyo on your module and figured the best options to use, you should consider the following steps

Expand Down Expand Up @@ -105,12 +113,6 @@ It's really up to you.
Run `npm publish`, Lyo will compile your module, and the bundle will be pushed to the npm registry with the rest of your module.
Congratulations, you're done! 💪

### Additional tips

- Don't use the bundle in a Node.js environment. The bundle is supposed to run in browsers only
- Don't immediately blame Lyo if it fails to compile your code. The error could come from [Browserify][browserify],
[Babel][babel] or [UglifyJS][uglify]


## Using Lyo on someone else's module

Expand Down Expand Up @@ -159,4 +161,5 @@ MIT © [Boris K](https://github.com/bokub)

[browserify]: https://github.com/browserify/browserify
[babel]: https://github.com/babel/babel
[babel-config]: https://babeljs.io/docs/en/configuration
[uglify]: https://github.com/mishoo/UglifyJS2
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "lyo",
"description": "Node.js to browser - The easy way",
"version": "1.1.2",
"version": "1.2.0",
"author": "Boris K",
"bin": {
"lyo": "bin/cli.js"
Expand Down

0 comments on commit a4ea4ec

Please sign in to comment.