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 09ee7d0 commit 266c0e3
Show file tree
Hide file tree
Showing 4 changed files with 145 additions and 49 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) 2015-19 Ionică Bizău <bizauionica@gmail.com> (http://ionicabizau.net)
Copyright (c) 2015-20 Ionică Bizău <bizauionica@gmail.com> (http://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
189 changes: 142 additions & 47 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. -->








[![deffy](http://i.imgur.com/k1hlQxA.png)](#)











# deffy

[![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/deffy.svg)](https://www.npmjs.com/package/deffy) [![Downloads](https://img.shields.io/npm/dt/deffy.svg)](https://www.npmjs.com/package/deffy) [![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>







> Small and fast library to set default values.
















## :cloud: Installation

```sh
Expand All @@ -22,6 +60,17 @@ yarn add deffy
```













## :clipboard: Example


Expand Down Expand Up @@ -53,17 +102,28 @@ console.log(Deffy("foo", function (input) {











## :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


Expand All @@ -83,12 +143,22 @@ Computes a final value by providing the input and default values.














## :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 @@ -107,65 +177,90 @@ 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:

- `ul`
- `bug-killer`
- `tilda`
- `same-time`
- `cli-box`
- `bindy`
- `set-or-get`
- `emoji-logger`
- `pixel-class`
- `obj-def`
- `cli-gh-cal`
- `cute-logger`
- `bloggify-template-renderer`
- `git-package-json`
- `bloggify-contact-form`
- `transformer`
- `git-stats`
- `svg.connectable.js`
- `engine-parser`
- `flow-api`
- `engine-builder`
- `enny`
- `engine-flow-types`
- `engine-tools`
- `ghosty`
- `web-term`
- `asciify-pixel`
- `blah`
- `bloggify-shop`
- `bloggify-paths`
- `bloggify-theme-renderer`
- `ascii-heart`
- `gh-notifier`
- `love-you`
- `parrot-bot`
- `value-breakpoints`
- `@isysd/gpm`
- `gpm`
- `bloggify-ws`










- [`ascii-heart`](https://github.com/nuvipannu/ascii-heart#readme) (by Nuvi Pannu)—Create ASCII hearts using Node.js.
- [`asciify-pixel`](https://github.com/IonicaBizau/asciify-pixel#readme)—Asciifies a pixel object.
- [`bindy`](https://github.com/IonicaBizau/bindy#readme)—Create array of functions bound to input arrays.
- [`blah`](https://github.com/IonicaBizau/blah)—A command line tool to optimize the repetitive actions.
- [`bloggify-contact-form`](https://github.com/Bloggify/contact-form)—The official contact form plugin for Bloggify
- [`bloggify-paths`](https://github.com/IonicaBizau/bloggify-paths#readme)—Helper library for maintaining the Bloggify paths in one place.
- [`bloggify-shop`](https://github.com/IonicaBizau/bloggify-shop#readme)—eCommerce plugin for Bloggify.
- [`bloggify-template-renderer`](https://github.com/Bloggify/template-renderer#readme) (by Bloggify)—The default template renderer for Bloggify.
- [`bloggify-theme-renderer`](https://github.com/Bloggify/theme-renderer#readme) (by Bloggify)—The default theme renderer for Bloggify.
- [`bloggify-ws`](https://github.com/Bloggify/bloggify-ws#readme) (by Bloggify)—Websockets for Bloggify Actions!
- [`bug-killer`](https://github.com/IonicaBizau/node-bug-killer)—Simple way to log messages in stdout or other stream.
- [`cli-box`](https://github.com/IonicaBizau/node-cli-box)—A library to generate ASCII boxes via NodeJS
- [`cli-gh-cal`](https://github.com/IonicaBizau/cli-gh-cal)—GitHub like calendar graphs in command line.
- [`cute-logger`](https://github.com/IonicaBizau/cute-logger)—Simple way to log messages in stdout or other stream.
- [`emoji-logger`](https://github.com/IonicaBizau/emoji-logger#readme)—Logging library based on flat colors and Emoji.
- [`engine-builder`](https://github.com/IonicaBizau/engine-parser) (by jillix)—Engine composition parser.
- [`engine-flow-types`](https://github.com/jillix/engine-flow-types#readme) (by jillix)—Low level library providing Engine flow types.
- [`engine-parser`](https://github.com/IonicaBizau/engine-parser) (by jillix)—Engine composition parser.
- [`engine-tools`](https://github.com/jillix/engine-tools) (by jillix)—Engine Tools library and CLI app.
- [`enny`](https://github.com/IonicaBizau/enny) (by jillix)—Generate Engine compositions from human-readable inputs.
- [`flow-api`](https://github.com/jillix/flow-api) (by jillix)—The flow api library and CLI app.
- [`gh-notifier`](https://bitbucket.org/IonicaBizau/gh-notifier#readme)—Receive desktop notifications from your GitHub dashboard.
- [`ghosty`](https://github.com/IonicaBizau/ghosty#readme)—A wrapper around PhantomJS, downloading the Phantom binary.
- [`git-package-json`](https://github.com/IonicaBizau/git-package-json#readme)—Get the package.json contents from git repositories.
- [`git-stats`](https://github.com/IonicaBizau/git-stats)—Local git statistics including GitHub-like contributions calendars.
- [`gpm`](https://github.com/IonicaBizau/gpm)—npm + git = gpm - Install NPM packages and dependencies from git repositories.
- [`love-you`](https://github.com/IonicaBizau/love-you#readme)—"I love you" in different languages.
- [`obj-def`](https://github.com/IonicaBizau/obj-def#readme)—Easily set default fields in objects.
- [`parrot-bot`](https://github.com/IonicaBizau/parrot-bot#readme)—A parrot-like bot you can talk with.
- [`pixel-class`](https://github.com/IonicaBizau/pixel-class#readme)—A tiny class for pixel manipulation.
- [`same-time`](https://github.com/IonicaBizau/same-time.js)—Call functions in parallel and store the results.
- [`set-or-get`](https://github.com/IonicaBizau/set-or-get.js)—Sets or gets an object field value.
- [`ssh-remote`](https://github.com/IonicaBizau/ssh-remote)—Automagically switch on the SSH remote url in a Git repository.
- [`svg.connectable.js`](https://github.com/jillix/svg.connectable.js) (by jillix)—A JavaScript library for connecting SVG things.
- [`tilda`](https://github.com/IonicaBizau/tilda)—Tiny module for building command line tools.
- [`transformer`](https://github.com/IonicaBizau/transformer#readme)—Transform data using synchronous and asynchronous functions.
- [`ul`](https://github.com/IonicaBizau/node-ul)—A minimalist utility library.
- [`value-breakpoints`](https://github.com/IonicaBizau/value-breakpoints#readme)—Run specific stuff when value reaches a specific range.
- [`web-term`](https://github.com/IonicaBizau/web-term)—A full screen terminal in your browser.

## :scroll: License

[MIT][license] © [Ionică Bizău][website]






[license]: /LICENSE
[website]: http://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(http%3A%2F%2Fionicabizau.net)&year=2015#license-mit
[website]: http://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 @@ -43,4 +43,4 @@
"cli.js",
"index.js"
]
}
}

0 comments on commit 266c0e3

Please sign in to comment.