File: README — Documentation for share_some

:heart::green_heart::yellow_heart::blue_heart::purple_heart::sparkling_heart::heart::green_heart::yellow_heart::blue_heart::purple_heart::sparkling_heart::heart::green_heart::yellow_heart::blue_heart::purple_heart::sparkling_heart::heart::green_heart::yellow_heart::blue_heart::purple_heart::sparkling_heart:

Share some love with our buddies rubyists! Say Thank You to all kind people, who spent their time to create and maintain open source software we use!

The Problem

Have you ever been thinking how important it is to say Thank You sometimes? And what pleasure it is to get kind words back! Especially when something being a hobby to you appears to be beneficial to somebody else. That's how open-source software works.

Unfortunately it happens all the time: amount of criticism outweights positive reviews. And you give up on that. But the project you was working on is awesome! We just didn't have enough of time or will to see you need our support.

NOT GONNA HAPPEN AGAIN!

Let's share a bit more of love! It's really easy to say Thank You to incredible people that just made part of your work. That spent their personal time to maintain something so useful. That allowed you to learn something new.

And with share_some_love it just got even easier.

Instalation

gem install share_some_love

Usage

If you are developing a GEM

cd your_gem_directory

share_some_love [by_gem]

Review ./LOVE.md and put it into the repo.

If you are developing a WEB application

cd your_project_directory

share_some_love site [by_gem]

Review ./public/love.html and put it into the repo.

Here are some sample files that were generated with this gem itself:

LOVE_by_gemfile.md – with by gem option
LOVE_by_author.md – without by gem option

I don't currently have styles and JS to make Web Projects love pages look pretty. So here is another chance to share some love: help me with that ;).

P.S. Don't forget to mention your page or file in twitter using hashtag #share_some_love

Contributors

@gazay

License

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.