https://github.com/ythecombinator/brazilian-horror-story
:speech_balloon: Some quotes from federal legislators during the vote on impeachment.
https://github.com/ythecombinator/brazilian-horror-story
Last synced: 4 months ago
JSON representation
:speech_balloon: Some quotes from federal legislators during the vote on impeachment.
- Host: GitHub
- URL: https://github.com/ythecombinator/brazilian-horror-story
- Owner: ythecombinator
- License: mit
- Created: 2016-04-18T02:26:44.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-04-24T22:54:53.000Z (about 9 years ago)
- Last Synced: 2025-01-18T10:29:02.590Z (5 months ago)
- Language: LiveScript
- Size: 555 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Some quotes from federal legislators during the vote on impeachment.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Node](#node)
- [CLI](#cli)
- [Development](#development)
- [Contributing](#contributing)
- [Motivation](#motivation)
- [License](#license)
## Installation
### Node
```sh
$ npm install --save brazilian-horror-story
```
### CLI
```sh
$ npm install -g brazilian-horror-story
```
## Usage
![Screenshot]()
### Node
```js
const quotes = require('brazilian-horror-story');
quotes();
```
returns an `Object` like this:
```json
{
"name": "Marco Feliciano",
"party": "PSC-SP",
"quote": "Com ajuda de Deus, pela minha família e pelo povo brasileiro, pelos evangélicos da nação toda, pelos meninos do MBL, pelo Vem pra Rua, dizendo que Olavo tem razão, dizendo tchau para essa querida, e dizendo tchau ao PT, partido das trevas, eu voto sim!"
}
```
### CLI
![GIFs <3]()
All you got to do is:
```sh
$ brazilian-horror-story
```
#### 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
¯\\\_(ツ)_/¯
## License
[brazilian-horror-story](https://github.com/mabrasil/brazilian-horror-story) is distributed under
the MIT License, available in this repository. All contributions are assumed to
be also licensed under the MIT License.