Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thatmattlove committed Oct 23, 2023
1 parent d38784d commit 22404b5
Showing 1 changed file with 34 additions and 25 deletions.
59 changes: 34 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,62 @@
<div align="center">
<h3>
<code>oui</code>
</h3>
<br/>
MAC Address CLI Toolkit
<br/>
<br/>
<h3>
<code>oui</code>
</h3>
<br/>
<b>MAC Address CLI Toolkit</b>
<br/>
<br/>
<a href="https://github.com/thatmattlove/oui/actions/workflows/test.yml">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/thatmattlove/oui/test.yml?style=for-the-badge">
</a>
<a href="https://github.com/thatmattlove/oui/releases">
<img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/thatmattlove/oui?label=version&style=for-the-badge">
</a>
<br/>
<a href="https://oui.is" target="_blank">
<img alt="Check Out the Web Version" src="https://img.shields.io/badge/Check_Out_the_Web_Version-10b981?style=for-the-badge">
</a>
</div>


## Installation

### macOS

#### Homebrew

```console
$ brew tap thatmattlove/oui
$ brew install oui
```bash
brew tap thatmattlove/oui
brew install oui
```

#### MacPorts

```console
$ sudo port install oui
```bash
sudo port install oui
```

### Linux

#### Debian/Ubuntu (APT)

```console
$ echo "deb [trusted=yes] https://repo.fury.io/thatmattlove/ /" > /etc/apt/sources.list.d/thatmattlove.fury.list
$ sudo apt update
$ sudo apt install oui
```bash
echo "deb [trusted=yes] https://repo.fury.io/thatmattlove/ /" > /etc/apt/sources.list.d/thatmattlove.fury.list
sudo apt update
sudo apt install oui
```

#### RHEL/CentOS (YUM)

```console
$ echo -e "[fury-thatmattlove]\nname=thatmattlove\nbaseurl=https://repo.fury.io/thatmattlove/\nenabled=1\ngpgcheck=0" > /etc/yum.repos.d/thatmattlove.fury.repo
$ sudo yum update
$ sudo yum install oui
```bash
echo -e "[fury-thatmattlove]\nname=thatmattlove\nbaseurl=https://repo.fury.io/thatmattlove/\nenabled=1\ngpgcheck=0" > /etc/yum.repos.d/thatmattlove.fury.repo
sudo yum update
sudo yum install oui
```

### Windows

TODO
Coming Soon

## Usage

Expand All @@ -64,7 +69,7 @@ USAGE:
oui [global options] command [command options] [arguments...]

VERSION:
1.0.0
2.0.4


COMMANDS:
Expand Down Expand Up @@ -117,9 +122,13 @@ $ oui convert F4:BD:9E:01:23:45
$ oui update
Updating MAC Address Database
██████████▌░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 20.0% Populating database...finished parsing vendors from MA-L registry
██████████████████▌░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 37.0% Populating database...finished parsing vendors from CID registry
███████████████████████████▌░░░░░░░░░░░░░░░░░░░░░░ 54.0% Populating database...finished parsing vendors from IAB registry
███████████████████████████████████▌░░░░░░░░░░░░░░ 71.0% Populating database...finished parsing vendors from MA-M registry
████████████████████████████████████████████▌░░░░░ 88.0% Populating database...finished parsing vendors from MA-S registry
██████████████████████████████████████████████████ 100.0% Completed
Updated MAC Address database (v0) with 44,839 records in 14 seconds
Updated MAC Address database (2.0.4) with 49,949 records in 5 seconds
```

![GitHub](https://img.shields.io/github/license/thatmattlove/oui?style=for-the-badge)
![GitHub](https://img.shields.io/github/license/thatmattlove/oui?style=for-the-badge&color=000000)

0 comments on commit 22404b5

Please sign in to comment.