diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 41 insertions, 5 deletions
@@ -4,17 +4,53 @@ Allows you to HOARd DOMains but with alot less pain associated with it. > "How to get my IP unbanned by Whois servers" <br> > -- Probably you after using this tool. +## Lates Update : tool now has a wrapper app for desktop* folks! +(No windows support only unix.) +Use the new make file to either `make pkg` for macass or `make deb` for debian systems. If you are running gentoo or anything else just the usual `make install`, to uninstall do `make uninstall` obv. (both install and uninstall will require le sudo or root) +<div style="width:80%; margin: auto;"> + +</div> -## Lates Update : tool now has a wrapper app for desktop* folks! -(No windows support only unix.) -Use the new make file to either `make pkg` for macass or `make deb` for debian systems. If you are running gentoo or anything else just the usual `make install`, to uninstall do `make uninstall` obv. (both install and uninstall will require le sudo or root) - +## What is `hoardom`? (a tldr) +`hoardom` is a rust based tool with cli, tui and to some degree gui interface. It is intended for checking and tracking the availability and status of domains and domain name ideas. + +In short the threeish interfaces serve the following purposes : +- CLI : Allows for quick and script/programm integratable use through its CLi interface returning domain availability status or lists with a wide but still sane amount of support of parameters +- TUI : Allows you to hunt and keep track of domain (name) ideas and quickly search up what is available and what isnt right in your unix terminal of choice +- GUI : Is a wrapper for the TUI that gives it its own icon in your app menu and when opened in dock/taskbar incase you wish to not use it that way. + +## How do I install `hoardom`? +`hoardom`'s tui and especially its gui interface officially only supports Unix based systems, Windows was net tested! <br> The regular cli interface should work with the built in main lookup and fallback whois implementations on Windows but that hasn't been tested. + +### Debian + +```bash +# Install RustUp Toolchain (Optional if already installed) +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + +# clone this repo +https://git.teleco.ch/crt/hoardom.git/about/?h=master + +``` + +> <br> - +> **_Question:_** Whats the like main use for this tool?<br><hr> +> -**_Answer:_** To allow looking up whether or not domain names are available or already registered without scrolling for ages through a long and slow web ui by your domain registrar of choice or needing to go through like 3 sites to cover all domain registrars you might use. <br> +> + +> <br> - +> **_Question:_** I dont need GUI all I want is a simple command?<br><hr> - +> **_Answer:_** Ofcourse! That was the initial idea, simply type : <br> +> --> `hoardom somedomain.com` to see if a specific domain is free <br> +> --> `hoardom somedomain` to check which top 100ish tlds are free <br> +> --> `hoardom -l all -a somedomain` to check all 600ish registerable domain names and explicitly show which ones are already taken <br> <br> - +> **_Note:_** If you need stuff like csv outputs or other silly features check [the CLi docs](doc/CLI.md) <br> + -## Quick Q & A `hoardom`? (tldr) |