From d77603522c8ed6091ffb167c56742b5e612bcd73 Mon Sep 17 00:00:00 2001 From: Andrew Tomaka Date: Wed, 17 Jan 2018 20:58:28 -0500 Subject: [PATCH] Add README --- .dockerignore | 1 + README.md | 32 ++++++++++++++++++++++++++++++++ bin/check | 3 +++ bin/setup | 3 +++ 4 files changed, 39 insertions(+) create mode 100644 README.md create mode 100755 bin/check create mode 100755 bin/setup diff --git a/.dockerignore b/.dockerignore index 2d2ecd6..593f846 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1 +1,2 @@ .git/ +.env diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb6c5a2 --- /dev/null +++ b/README.md @@ -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. diff --git a/bin/check b/bin/check new file mode 100755 index 0000000..76d1ec7 --- /dev/null +++ b/bin/check @@ -0,0 +1,3 @@ +#!/bin/bash + +docker run --env-file .env ccbw diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..62e91c1 --- /dev/null +++ b/bin/setup @@ -0,0 +1,3 @@ +#!/bin/bash + +docker build --tag ccbw .