check-att

Crates.io	check-att
lib.rs	check-att
version	0.1.2
source	src
created_at	2023-01-25 05:17:56.624899
updated_at	2023-11-10 03:20:25.667415
description	A small script to check if a house has ATT fiber availible
homepage	https://s-mil.github.io/att_availability_checker/
repository	https://github.com/s-mil/att_availability_checker
max_upload_size
id	767138
size	42,495

Sam Miller (s-mil)

documentation

README

Table of Contents

1. About The Project
   • Built WithRust
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A basic script to check if a given address has att fiber availible

(back to top)

Built With

Rust

(back to top)

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.

Prerequisites

Have rust installed

Installation

clone the repo

cargo build

(back to top)

Usage

cargo run <zip code> "<street address>" cargo run 12345 "123 main street"

Returns true if att fiber is available

(back to top)

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/s-mil/att_availability_checker

(back to top)