Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ythecombinator/happy-valentines
💖Simple module to show your love on this Valentine's Day.
https://github.com/ythecombinator/happy-valentines
Last synced: about 1 month ago
JSON representation
💖Simple module to show your love on this Valentine's Day.
- Host: GitHub
- URL: https://github.com/ythecombinator/happy-valentines
- Owner: ythecombinator
- License: mit
- Created: 2016-02-14T23:33:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-02-29T00:58:23.000Z (over 8 years ago)
- Last Synced: 2024-08-09T09:40:19.487Z (3 months ago)
- Language: LiveScript
- Homepage: https://www.npmjs.com/package/happy-valentines
- Size: 31.3 KB
- Stars: 52
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Simple module to show your love on this Valentine's Day.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Contributing](#contributing)
- [Motivation](#motivation)
- [License](#license)
- [Credits](#credits)
## Installation
### Node
```sh
$ npm install --save happy-valentines
```
### CLI
```sh
$ npm install -g happy-valentines
```
## Usage
> Send this project to whom you **love** and as soon as the person installs and
runs, it will wish that special person a *Happy Valentine's Day*.
### Node
```js
const valentines = require('happy-valentines');
valentines();
/* =>
LoveLoveLov eLoveLoveLo
veLoveLoveLoveLove LoveLoveLoveLoveLo
veLoveLoveLoveLoveLoveL oveLoveLoveLoveLoveLove
LoveLoveLoveLoveLoveLoveL oveLoveLoveLoveLoveLoveLo
veLoveLoveLoveLoveLoveLoveL oveLoveLoveLoveLoveLoveLove
LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLo
veLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
veLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLo
veLoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLove
LoveLoveLoveLoveLoveLoveLoveLoveLoveLoveLo
veLoveLoveLoveLoveLoveLoveLoveLoveLove
LoveLoveLoveLoveLoveLoveLoveLoveLo
veLoveLoveLoveLoveLoveLoveLove
LoveLoveLoveLoveLoveLoveLo
veLoveLoveLoveLoveLo
veLoveLoveLo
ve
Happy Valentine's Day, dear Matheus Brasil.
*/
```
### CLI
```sh
$ happy-valentines
```
#### Options
| **Option** | **Description** |
|-------------|----------------------------------------------|
| `--help` | Shows project description and how to use it. |
| `--version` | Displays the current version. |
## Development
All the tasks needed for development automation are defined in the
[`package.json`](package.json) *scripts* property and can be run via:
`npm run `
Here is a summary of all the commands:
| **Command** | **Description** |
|---------------|------------------------------------------------------------------------------------------|
| `compile` | Runs the Livescript compiler on the source. |
| `test` | Runs [Mocha](https://mochajs.org/) in BDD mode. |
| `build` | Runs both `compile` and `test` commands. |
## Contributing
Contributions are very welcome! If you'd like to contribute, these
[guidelines](CONTRIBUTING.md) may help you.
## Motivation
You know what they say: *love is in the air*
¯\\\_(ツ)_/¯
## License
[happy-valentines](https://github.com/mabrasil/happy-valentines) is distributed under
the MIT License, available in this repository. All contributions are assumed to
be also licensed under the MIT License.
## Credits
Part of the [*hearts art*](hearts.json) was taken from
[AsciiWorld.com](http://www.asciiworld.com/-Hearts-.html).