jakewmeyer/Geo

View on GitHub
README.md

Summary

Maintainability
Test Coverage
<div align="center">

![Imgur](http://i.imgur.com/Jk3L3EO.png)

# Geo
### A Bash utility for easy wan, lan, router, dns, mac address, and geolocation output, with clean stdout for easy piping

[![GitHub release](https://img.shields.io/github/release/jakewmeyer/Geo.svg)]()
[![Build Status](https://travis-ci.org/jakewmeyer/Geo.svg?branch=master)](https://travis-ci.org/jakewmeyer/Geo)
[![Code Climate](https://codeclimate.com/github/jakewmeyer/Geo/badges/gpa.svg)](https://codeclimate.com/github/jakewmeyer/Geo)
[![Platform](https://img.shields.io/badge/platform-MacOS%20%2B%20Linux-blue.svg)]()

</div>

## Install / Setup

**MacOS**
```bash
brew install jakewmeyer/Geo/geo
```

**Linux**
* [https://github.com/jakewmeyer/Geo/archive/v1.2.0.tar.gz](https://github.com/jakewmeyer/Geo/archive/v1.2.0.tar.gz)
* An AUR package is available [here](https://aur.archlinux.org/packages/geo-bash/) for those on Arch Linux courtesy of [zethra](https://github.com/zethra)

**Linux Dependanices**
* [Dnsutils](https://packages.debian.org/jessie/dnsutils) is required for WAN search on Linux

## Usage

![Imgur](http://i.imgur.com/1BWNRi1.png)

## Testing

Install `bats` and execute `bats test/*`

## FAQ's / Contact
* If you run into any issues, please open an issue ASAP and I'll work to get it resolved and merged.
* Terminal used is [Hyper.js](https://hyper.is/) -> Background Color: #292937
* Using [Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh), Robby Russell theme, [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting), and [zsh_autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)