Metadata-Version: 2.1
Name: apmultitool
Version: 0.1.3
Summary: multitool is a simple cli with multiple commonly used features.
Home-page: https://github.com/alexpdev/multitool
Author: alexpdev
Author-email: alexpdev@protonmail.com
License: The MIT License (MIT)
        =====================
        
        Copyright © `<year>` `<copyright holders>`
        
        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.
        
Keywords: CLI
Platform: UNKNOWN
License-File: LICENSE

# Multitool

![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/multitool)
![GitHub contributors](https://img.shields.io/github/contributors/alexpdev/multitool)
![GitHub stars](https://img.shields.io/github/stars/alexpdev/multitool?style=social)
![GitHub forks](https://img.shields.io/github/forks/alexpdev/multitool?style=social)

`multiTool` is a command line interface with an array of features that can generally make life easier.

## Prerequisites

Before you begin, ensure you have met the following requirements:

* You have `python3` installed

## Installing Multitool

To install `multitool`, follow these steps:

> in a terminal

```bash
git clone https://github.com/alexpdev/multitool.git
cd multitool
python setup.py install
```

## Using Multitool

To use `multitool`, follow these steps:

### TODO

## Contributing to Multitool

To contribute to `multitool`, follow these steps:

1. Fork this repository.
2. Create a branch: `git checkout -b <branch_name>`.
3. Make your changes and commit them: `git commit -m '<commit_message>'`
4. Push to the original branch: `git push origin <project_name>/<location>`
5. Create the pull request.

Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).

## Contact

If you want to contact me you can reach me through Github Issues for the repository.

## License

This project uses the following license: [MIT](https://github.com/alexpdev/multitool/LICENSE.md).


