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

Commit a4ea4ec

Browse files
committed
Publish 1.2.0
1 parent b4b639f commit a4ea4ec

3 files changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Lyo](https://i.imgur.com/nt5bYNJ.png)](https://github.com/bokub/lyo/issues/1)
1+
![Lyo](https://user-images.githubusercontent.com/17952318/44954822-2055cc80-aea9-11e8-9ebd-b10619f80171.png)
22

33
> Node.js to browser - The easy way
44
@@ -65,7 +65,15 @@ $ lyo --help
6565
```
6666

6767

68-
## Recommended workflow
68+
## Tips
69+
70+
- Add a `.babelrc` file at the root of your project to [configure][babel-config] the Babel compilation step
71+
- The bundle is supposed to run in browsers. A bundle used in a Node.js program will probably be slower than the original module
72+
- Don't blame Lyo if it fails to compile your code. The error could come from [Browserify][browserify], [Babel][babel] or [UglifyJS][uglify]
73+
- 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
74+
75+
76+
## Using Lyo on your own module
6977

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

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

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

115117
## Using Lyo on someone else's module
116118

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

160162
[browserify]: https://github.com/browserify/browserify
161163
[babel]: https://github.com/babel/babel
164+
[babel-config]: https://babeljs.io/docs/en/configuration
162165
[uglify]: https://github.com/mishoo/UglifyJS2

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "lyo",
33
"description": "Node.js to browser - The easy way",
4-
"version": "1.1.2",
4+
"version": "1.2.0",
55
"author": "Boris K",
66
"bin": {
77
"lyo": "bin/cli.js"

0 commit comments

Comments
 (0)