Skip to content

Commit

Permalink
Remove license section from README
Browse files Browse the repository at this point in the history
  • Loading branch information
MattInternet committed Oct 5, 2024
1 parent 7cc6e0f commit 56686d8
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ The goal of dug is to make it easy to check the propagation of DNS records. It i
For detailed documentation check out [dug.unfrl.com](https://dug.unfrl.com)

## Usage

The easiest way to explore dug is through the help.
* `dug help` -> Get top level help explaining the different verbs
* `dug help run` or `dug run --help` -> Get details about a specific verb (run, which is the default)
* `dug help update` or `dug update --help` -> Get details about the update verb

- `dug help` -> Get top level help explaining the different verbs
- `dug help run` or `dug run --help` -> Get details about a specific verb (run, which is the default)
- `dug help update` or `dug update --help` -> Get details about the update verb

The simplest way to get started is to just run a query against the domain whose DNS records you're updating.
For example: `dug git.kaijucode.com`:
Expand All @@ -25,33 +27,37 @@ You can also do complicated things like ask for specific record types, use the m
![](cli/Resources/gif2.gif)

## Localization

dug automatically uses the current system's culture for localization. (You can override LANG on linux to test it).

Currently supports the following languages:

- (en) English
- (es) Spanish
- (de) German

## Installation

### Linux Deb (Debian, Ubuntu, Mint, Pop!_os)
### Linux Deb (Debian, Ubuntu, Mint, Pop!\_os)

1. Go to the [latest release](https://github.com/unfrl/dug/releases/latest) and download the .deb package.
* It should look like `dug.<version>.linux-x64.deb`
- It should look like `dug.<version>.linux-x64.deb`
2. On most distros double clicking the .deb package will allow you to install via a UI, alternatively it can be installed by running `sudo dpkg -i ./dug.<version>.linux-x64.deb`

### Linux RPM (RHEL, CentOS, Fedora)

1. Go to the [latest release](https://github.com/unfrl/dug/releases/latest) and download the .rpm package.
* It should look like `dug.<version>.linux-x64.rpm`
- It should look like `dug.<version>.linux-x64.rpm`
2. On most distros double clicking the .deb package will allow you to install via a UI, alternatively it can be installed by running `rpm -i ./dug.<version>.linux-x64.deb`

### Arch

A friend put dug in the AUR! [here](https://aur.archlinux.org/packages/dug-git/)

### Snap

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/unfrl-dug)

> Install snap if you dont have it [Guide](https://snapcraft.io/docs/getting-started#heading--install)
1. Run: `sudo snap install unfrl-dug`
Expand All @@ -64,20 +70,25 @@ Note: Annoyingly `dug` is a reserved package name and I am waiting for them to g
Not sure if this counts as an "Installation" but there is a docker image available [here](https://hub.docker.com/r/unfrl/dug)

### OSX

> Not Officially Supported Yet
1. Go to the [latest release](https://github.com/unfrl/dug/releases/latest) and download the osx binary.
* It should look like `dug-osx-x64`
- It should look like `dug-osx-x64`
2. You should be able to download that, make is executable, and run it from the terminal. Then you can put it somewhere and update your path so you can execute it from anywhere.

### Windows

#### Chocolatey (choco cli)

> Chocolatey manually reviews all packages, which takes a while, so this can lag behind the latest. [status info here](https://chocolatey.org/packages/dug)
1. Run: `choco install dug`

#### Executable

1. Go to the [latest release](https://github.com/unfrl/dug/releases/latest) and download the .exe binary.
* It should look like `dug.exe`
- It should look like `dug.exe`
2. You should be able to download that and run it from the terminal. Then you can put it somewhere and update your path so you can execute it from anywhere.

## Development
Expand All @@ -100,7 +111,4 @@ If you didnt do that you can run this to restore the BATS submodules into ./cli.

Once you have BATS you should be able to simply run the BATS tests with: `./cli.tests/bats/run.sh`

## License
The license used by dug, [here](./cli/LICENSE), is very explicitly designed to try to keep capitalists from benefiting from this tool. This is not a traditional license but it is very simple, please read it.

Made with ❤️ by [Unfrl](https://unfrl.com)

0 comments on commit 56686d8

Please sign in to comment.