Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lespinalrivera/lame-excuses

Random Lame Excuses Library :sparkles::rocket::sparkles:
https://github.com/lespinalrivera/lame-excuses

acknowledgments contributions-welcome excuses mit-license nodejs

Last synced: about 2 months ago
JSON representation

Random Lame Excuses Library :sparkles::rocket::sparkles:

Awesome Lists containing this project

README

        

# Lame Excuses Library

**Lame Excuse Library** - Here is an npm micro-library to get a quick random excuse.

[![Travis Build](https://img.shields.io/travis/lespinalrivera/lame-excuses.svg?style=flat-square)](https://travis-ci.org/lespinalrivera/lame-excuses)
[![Downloads](https://img.shields.io/npm/dt/lame-excuses.svg?style=flat-square)](https://www.npmjs.com/package/lame-excuses)
[![Coverage](https://img.shields.io/codecov/c/github/lespinalrivera/lame-excuses.svg?style=flat-square)](https://codecov.io/gh/lespinalrivera/lame-excuses)
[![Npm-Version](https://img.shields.io/npm/v/lame-excuses.svg?style=flat-square)](https://www.npmjs.com/package/lame-excuses)
[![Issues](https://img.shields.io/github/issues/lespinalrivera/lame-excuses.svg?style=flat-square)](https://github.com/lespinalrivera/lame-excuses/issues)
[![License](https://img.shields.io/npm/l/lame-excuses.svg?style=flat-square)](https://github.com/lespinalrivera/lame-excuses/blob/master/LICENSE)
[![Stars](https://img.shields.io/github/stars/lespinalrivera/lame-excuses.svg?style=social&label=Star)](https://github.com/lespinalrivera/lame-excuses/stargazers)

## Getting Started

1- Run `npm install lame-excuses`

### Prerequisites

1- Download Nodejs form [Nodejs.org](https://nodejs.org/)

(Updated until here)

```
Give examples
```

### Using this Library

Accepted Commands:

random()

all

random(n)

Give a list from the beginning to the end

```
until finished
```

End with an example of they should see in their dev environment

```
(A screenshot would be good here)
```

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## Deployment

Add additional notes about how to deploy this on a live system

## Built With

* [Nodejs](https://nodejs.org/) - The web framework used
* [travis-ci](https://travis-ci.org/) - Build Management
* [semantic-release](https://github.com/semantic-release/cli) - Automatic Release Versioning

## Contributing

Anyone can help make this project better - For a list of previous contributors check and the process for submitting pull requests to us: [Contributors.md](https://github.com/lespinalrivera/lame-excuses/blob/master/Contributors.md).

## Versioning

###### Automatic Version Control done by semantic-release.

Corrent Version: [![Npm-Version](https://img.shields.io/npm/v/lame-excuses.svg?style=flat-square)](https://www.npmjs.com/package/lame-excuses)

## Authors

* **Luis Espinal** - *Initial work* - [SurreyCodeCamp](https://github.com/Surrey-Code-Camp)

See also the list of [Contributors.md](https://github.com/lespinalrivera/lame-excuses/blob/master/Contributors.md) who participated in this project.

## License

This project is licensed under the MIT - see the [LICENSE.md](https://github.com/lespinalrivera/lame-excuses/blob/master/LICENSE) file for details

## Acknowledgments

* Contribute to these templates and be acknowledge for that on this section.