<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->

<a name="readme-top"></a>

<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->

<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->

[![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]

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <!-- <a href="https://github.com/deepanchal/aws-iot-mqtt-cli"> -->
  <!--   <img src="images/logo.png" alt="Logo" width="80" height="80"> -->
  <!-- </a> -->

<h1 align="center">aws-iot-mqtt-cli</h1>

  <p align="center">
    MQTT CLI for AWS IoT
    <br />
    <a href="https://github.com/deepanchal/aws-iot-mqtt-cli/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=Bug">Report Bug</a>
    ·
    <a href="https://github.com/deepanchal/aws-iot-mqtt-cli/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=Feature">Request Feature</a>
  </p>
</div>

<!-- ABOUT THE PROJECT -->

## 🌟 About The Project

Simple mqtt cli for AWS IoT

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### 🏗️ Built With

- [`rust`](https://www.rust-lang.org/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## 🚀 Getting Started

### 📥 Installing

#### Cargo

```bash
cargo install --git https://github.com/deepanchal/aws-iot-mqtt-cli
```

Once it's installed, simply run

```bash
aws-iot-mqtt-cli
```

### 🏃 Running project locally

To get a local copy up and running follow these simple example steps.

1. Install rust: https://www.rust-lang.org/

2. Clone the repo.

```bash
git clone https://github.com/deepanchal/aws-iot-mqtt-cli.git
```

3. cd into repo.

```bash
cd aws-iot-mqtt-cli
```

4. Run cli

```sh
cargo run
```

<!-- USAGE EXAMPLES -->

## 📝 Usage

### 🏃 Run

```sh
cargo run
```

### 🏗️ Build

```sh
cargo build
```

### 🧪 Run Tests

```sh
cargo test
```

<p align="right">(<a href="#readme-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 feat/amazing-feature`)
3. Commit your Changes (`git commit -m 'feat: add some amazing-feature'`)
4. Push to the Branch (`git push origin feat/amazing-feature`)
5. Open a Pull Request

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LICENSE -->

## 📄 License

Distributed under the MIT License. See [`LICENSE`](LICENSE) for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/deepanchal/aws-iot-mqtt-cli.svg?style=for-the-badge
[contributors-url]: https://github.com/deepanchal/aws-iot-mqtt-cli/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/deepanchal/aws-iot-mqtt-cli.svg?style=for-the-badge
[forks-url]: https://github.com/deepanchal/aws-iot-mqtt-cli/network/members
[stars-shield]: https://img.shields.io/github/stars/deepanchal/aws-iot-mqtt-cli.svg?style=for-the-badge
[stars-url]: https://github.com/deepanchal/aws-iot-mqtt-cli/stargazers
[issues-shield]: https://img.shields.io/github/issues/deepanchal/aws-iot-mqtt-cli.svg?style=for-the-badge
[issues-url]: https://github.com/deepanchal/aws-iot-mqtt-cli/issues
[license-shield]: https://img.shields.io/github/license/deepanchal/aws-iot-mqtt-cli.svg?style=for-the-badge
[license-url]: https://github.com/deepanchal/aws-iot-mqtt-cli/blob/main/LICENSE

