Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent dabdbdc commit 1839d57
Show file tree
Hide file tree
Showing 4 changed files with 120 additions and 18 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ node_modules
*.env
.DS_Store
package-lock.json
.bloggify/*
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016-19 Ionică Bizău <[email protected]> (https://ionicabizau.net)
Copyright (c) 2016-20 Ionică Bizău <[email protected]> (https://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
133 changes: 117 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,54 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->








[![babel-it](http://i.imgur.com/DNBxR1S.png)](#)











# `$ babel-it`

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/babel-it.svg)](https://www.npmjs.com/package/babel-it) [![Downloads](https://img.shields.io/npm/dt/babel-it.svg)](https://www.npmjs.com/package/babel-it) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>







> Babelify your code before `npm publish`.
















## :cloud: Installation

You can install the package globally and use it as command line tool:
Expand All @@ -35,24 +73,69 @@ Usage: babel-it [options]
Babelify your code before `npm publish`.
Options:
-i, --input <path> The input file paths.
-I, --ignore <path> The files to ignore.
--skip-publish If this option is provided, the `npm publish` step
will be skipped.
--skip-checkout If this option is provided, the `git checkout` step
will be skipped.
-v, --version Displays version information.
--skip-publish If this option is provided, the `npm publish` step
will be skipped.
-I, --ignore <path> The files to ignore.
-i, --input <path> The input file paths.
-h, --help Displays this help.
-v, --version Displays version information.
Documentation can be found at https://github.com/IonicaBizau/babel-it#readme.
```






















## :question: Get Help

There are few ways to get help:



1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
















## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).

Expand All @@ -71,16 +154,32 @@ However, if you get some profit from this or just want to encourage me to contin
Thanks! :heart:
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- `ship-release`






- [`ship-release`](https://github.com/IonicaBizau/ship-release#readme)—Publish new versions on GitHub and npm with ease.

## :sparkles: Related

- [`ship-release`](https://github.com/IonicaBizau/ship-release#readme)—Publish new versions on GitHub and npm with ease.
- [`dist-it`](https://github.com/IonicaBizau/dist-it)—Generate minified bundles from modular inputs using Browserify.



Expand All @@ -89,16 +188,18 @@ If you are using this library in one of your projects, add it in this list. :spa
[MIT][license] © [Ionică Bizău][website]






[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg

[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2016#license-mit
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@
"dist-it"
]
}
}
}

0 comments on commit 1839d57

Please sign in to comment.