Fast-Typy 0.1.0
A command line typing game
Keywords: typing game,command line,game,type


<div id="top"></div>



<!-- PROJECT SHIELDS -->
[![Pypi][pypi-shield]][pypi-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]



<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/PrynsTag/Fast-Typy">
    <img src="images/logo.png" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">Fast-Typy</h3>

  <p align="center">
    A command line game for simple, fast, and easy to use typing game.
    <br />
    <a href="https://github.com/PrynsTag/Fast-Typy"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/PrynsTag/Fast-Typy">View Demo</a>
    ·
    <a href="https://github.com/PrynsTag/Fast-Typy/issues">Report Bug</a>
    ·
    <a href="https://github.com/PrynsTag/Fast-Typy/issues">Request Feature</a>
  </p>
</div>



<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>



<!-- ABOUT THE PROJECT -->
## About The Project

[![Product Name Screen Shot][product-screenshot]](https://example.com)

<p align="right">(<a href="#top">back to top</a>)</p>



### Built With

* [Python](https://python.org/)

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

<!-- FOR LATER USE 
### Prerequisites

This is an example of how to list things you need to use the software and how to install them.
* pip
  ```sh
  pip install fast-typy
  ```
-->

### Installation

1. Clone the repo or install the package from [PyPI](https://pypi.org/project/fast-typy/)
   ```sh
   git clone https://github.com/PrynsTag/Fast-Typy.git
   ```
    **OR**
    ```sh
    pip install fast-typy
    ```

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->
## Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](README.md)_

<p align="right">(<a href="#top">back to top</a>)</p>


<!-- ROADMAP -->
## Roadmap

- [ ] Replace txt files with a database
- [ ] Add API
- [ ] Create a web or desktop app

See the [open issues](https://github.com/PrynsTag/Fast-Typy/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- LICENSE -->
## License

Distributed under the MIT License. See the [LICENSE](LICENSE) file for more information.

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- CONTACT -->
## Contact

Prince Carl Velasco - [@PrynsTag](https://twitter.com/PrynsTag) - paa0gwv7r@mozmail.com

Project Link: [https://github.com/PrynsTag/Fast-Typy](https://github.com/PrynsTag/Fast-Typy)

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- ACKNOWLEDGMENTS -->
## Acknowledgments

* [Python](https://www.python.org/)
* [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
* [shields.io](https://shields.io/)

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- MARKDOWN LINKS & IMAGES -->
[pypi-shield]: https://img.shields.io/pypi/v/Fast-Typy?label=Pypi%20Package&style=for-the-badge
[pypi-url]: https://pypi.org/project/Fast-Typy/ 
[contributors-shield]: https://img.shields.io/github/contributors/PrynsTag/Fast-Typy.svg?style=for-the-badge
[contributors-url]: https://github.com/PrynsTag/Fast-Typy/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/PrynsTag/Fast-Typy.svg?style=for-the-badge
[forks-url]: https://github.com/PrynsTag/Fast-Typy/network/members
[stars-shield]: https://img.shields.io/github/stars/PrynsTag/Fast-Typy.svg?style=for-the-badge
[stars-url]: https://github.com/PrynsTag/Fast-Typy/stargazers
[issues-shield]: https://img.shields.io/github/issues/PrynsTag/Fast-Typy.svg?style=for-the-badge
[issues-url]: https://github.com/PrynsTag/Fast-Typy/issues
[license-shield]: https://img.shields.io/github/license/PrynsTag/Fast-Typy.svg?style=for-the-badge
[license-url]: https://github.com/PrynsTag/Fast-Typy/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/princevelasco
[product-screenshot]: images/screenshot.png