From d6aa9baa54c9c415f796cb77129fd1366744ccb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Sun, 9 Aug 2020 17:41:55 +0300 Subject: [PATCH] Updated docs --- .gitignore | 1 + LICENSE | 2 +- README.md | 163 ++++++++++++++++++++++++++++++++++++++++++++++++--- package.json | 2 +- 4 files changed, 158 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index af96bda..2ca2591 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ node_modules *.env .DS_Store package-lock.json +.bloggify/* diff --git a/LICENSE b/LICENSE index 02a53f5..6438c7e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016-19 Ionică Bizău (https://ionicabizau.net) +Copyright (c) 2016-20 Ionică Bizău (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 diff --git a/README.md b/README.md index e47e6f3..d749983 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,74 @@ + + + + + + + + + + + + + + + + + + + +# obj-unflatten + + [![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/obj-unflatten.svg)](https://www.npmjs.com/package/obj-unflatten) [![Downloads](https://img.shields.io/npm/dt/obj-unflatten.svg)](https://www.npmjs.com/package/obj-unflatten) [![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) + +Buy Me A Coffee + + + + + -# obj-unflatten [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![Version](https://img.shields.io/npm/v/obj-unflatten.svg)](https://www.npmjs.com/package/obj-unflatten) [![Downloads](https://img.shields.io/npm/dt/obj-unflatten.svg)](https://www.npmjs.com/package/obj-unflatten) [![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) > Convert flatten objects in nested ones. + + + + + + + + + + + + + + + + ## :cloud: Installation ```sh -$ npm i --save obj-unflatten +# Using npm +npm install --save obj-unflatten + +# Using yarn +yarn add obj-unflatten ``` + + + + + + + + + + + ## :clipboard: Example @@ -33,6 +92,30 @@ console.log(unflatten({ // { name: { first: 'Johnny', last: 'B.' }, age: 20 } ``` + + + + + + + + + + +## :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: + + + + + ## :memo: Documentation @@ -40,6 +123,7 @@ console.log(unflatten({ Convert flatten objects in nested ones. #### Params + - **Object** `flatten`: The flatten object that should be converted. - **Object** `separator`: The field separator (default: `"."`). @@ -48,12 +132,66 @@ Convert flatten objects in nested ones. + + + + + + + + + + + ## :yum: How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. -## :sparkles: Related - - [`obj-flatten`](https://github.com/IonicaBizau/obj-flatten) – Convert nested objects in flatten ones. +## :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). + +However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it: + + + - Starring and sharing the projects you like :rocket: + - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: + - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: + - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone). + - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6` + + ![](https://i.imgur.com/z6OQI95.png) + + +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: + + - `elasticfire` + + + + + + + + @@ -61,10 +199,19 @@ Have an idea? Found a bug? See [how to contribute][contributing]. [MIT][license] © [Ionică Bizău][website] -[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW -[donate-now]: http://i.imgur.com/6cMbHOC.png -[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2016#license-mit -[website]: http://ionicabizau.net + + + + +[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 diff --git a/package.json b/package.json index 7aa56c8..907dd25 100644 --- a/package.json +++ b/package.json @@ -53,4 +53,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}