From 1ace625f8c43ec2c4eeb6e0a0c8cf98d3a0b7f31 Mon Sep 17 00:00:00 2001 From: Josh Harshman Date: Tue, 16 May 2023 12:49:49 -0600 Subject: [PATCH] add readme --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..748a150 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# fwsync + +![CI](https://github.com/jharshman/fwsync/actions/workflows/ci.yaml/badge.svg?branch=master) + +Provides CLI interface to update your personal Firewall Rules +associated with your Cloud Development VM. + +## Installation + +TODO how to install + +## Usage + +### Init +After installing, you can invoke the CLI by typing `fwsync` in your terminal. +This by default will display some usage information. + +To initialize fwsync type `fwsync init`. This will walk you through steps in +selecting the correct firewall to manage and will write out fwsync's config file +which will be located at `$HOME/.bitly_firewall`. + +### Update +If your IP updates and you notice you've lost access to your CloudVM, +you can invoke `fwsync update` to automatically detect your new IP address +and update your Firewall Rule. \ No newline at end of file