Merge pull request #9 from cytopia/documentation

Add install instructions

Makefile

@@ -17,16 +17,39 @@ FL_IMAGE   = cytopia/file-lint
 FL_VERSION = 0.4
 FL_IGNORES = .git/,.github/
 
+BIN_DIR = /usr/local/bin
+
 
 # -------------------------------------------------------------------------------------------------
 # Default target
 # -------------------------------------------------------------------------------------------------
+.PHONY: help
 help:
-	@echo "lint                   Lint files"
+	@echo "lint       Lint files"
+	@echo "install    Install aws-export-assume-profile to $(BIN_DIR)"
+	@echo "uninstall  Remove aws-export-assume-profile from $(BIN_DIR)"
+
+
+# -------------------------------------------------------------------------------------------------
+# Install target
+# -------------------------------------------------------------------------------------------------
+.PHONY: install
+install:
+	install -m 755 aws-export-assume-profile $(BIN_DIR)/aws-export-assume-profile
 
+.PHONY: uninstall
+uninstall:
+	rm $(BIN_DIR)/aws-export-assume-profile
+
+
+# -------------------------------------------------------------------------------------------------
+# Lint target
+# -------------------------------------------------------------------------------------------------
+.PHONY: lint
 lint: lint-files
 lint: lint-shell
 
+.PHONY: lint-files
 lint-files: _pull-fl
 	@# Lint all files
 	@echo "################################################################################"
@@ -40,6 +63,7 @@ lint-files: _pull-fl
 	@docker run --rm $$(tty -s && echo "-it" || echo) -v $(CURRENT_DIR):/data $(FL_IMAGE):$(FL_VERSION) file-utf8-bom --text --ignore '$(FL_IGNORES)' --path .
 	@echo
 
+.PHONY: lint-shell
 lint-shell: _pull-sc
 	@# Lint all Shell files
 	@echo "################################################################################"
@@ -56,11 +80,14 @@ lint-shell: _pull-sc
 	fi;
 	@echo
 
+
 # -------------------------------------------------------------------------------------------------
 # Helper Targets
 # -------------------------------------------------------------------------------------------------
+.PHONY: _pull-fl
 _pull-fl:
 	docker pull $(FL_IMAGE):$(FL_VERSION)
 
+.PHONY: _pull-sc
 _pull-sc:
 	docker pull $(SC_IMAGE):$(SC_VERSION)

README.md

@@ -10,7 +10,7 @@ This tool requires `aws` cli and retrieves credentials via `aws sts assume-role`
 **Note:** Wrap the command in **`$(aws-export-assume-profile)`** to actually export your profiled environment variables.
 
 
-## But why?
+## :question: But why?
 
 Most AWS related tools support profiles out of the box, such as the `aws-cli` (Example: `aws ec2 --profile <AWS_PROFILE>`). However sometimes it is required to have your chosen aws profile available as shell variables. One of the use cases is when you use Docker and want a specific login available inside your container.:
 ```bash
@@ -26,7 +26,7 @@ user> docker run --rm -it \
 ```
 
 
-## Available exports
+## :arrow_forward: Available exports
 
 The following export variables are currently supported.
 
@@ -44,7 +44,14 @@ The following export variables are currently supported.
 > https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html
 
 
-## Examples
+
+## :tada: Installation
+```bash
+sudo make install
+```
+
+
+## :bulb: Examples
 
 This tool simply output the exports to stdout. In order to auto-source them, wrap the command in **`$(...)`**.
 
@@ -105,7 +112,7 @@ user> $(aws-export-assume-profile -u)
 ```
 
 
-## Usage
+## :computer: Usage
 
 ```bash
 Usage: aws-export-assume-profile [profile] [config]
@@ -153,7 +160,8 @@ Copyright (c) 2019 cytopia
 https://github.com/cytopia/aws-export-assume-profile
 ```
 
-## License
+
+## :page_facing_up: License
 
 **[MIT License](LICENSE.md)**