Add README
This commit is contained in:
parent
d08054cc48
commit
d77603522c
4 changed files with 39 additions and 0 deletions
|
@ -1 +1,2 @@
|
||||||
.git/
|
.git/
|
||||||
|
.env
|
||||||
|
|
32
README.md
Normal file
32
README.md
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
# cc-bandwidth
|
||||||
|
|
||||||
|
Ruby script to grab your current Comcast bandwidth usage.
|
||||||
|
|
||||||
|
## Pre-requisites
|
||||||
|
|
||||||
|
* Docker
|
||||||
|
* Comcast
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Pre-built
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run \
|
||||||
|
--env COMCAST_USERNAME=username \
|
||||||
|
--env COMCAST_PASSWORD=password \
|
||||||
|
atomaka/ccbw
|
||||||
|
```
|
||||||
|
|
||||||
|
### From Source
|
||||||
|
|
||||||
|
* Clone repository
|
||||||
|
* `cp .env.sample .env`
|
||||||
|
* Add username and password
|
||||||
|
* `bin/setup`
|
||||||
|
* `bin/check`
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
If login fails, login into your account manually via the web one time and
|
||||||
|
confirm any messages, then retry.
|
3
bin/check
Executable file
3
bin/check
Executable file
|
@ -0,0 +1,3 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
docker run --env-file .env ccbw
|
3
bin/setup
Executable file
3
bin/setup
Executable file
|
@ -0,0 +1,3 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
docker build --tag ccbw .
|
Loading…
Reference in a new issue