From ee17cec85d3d9ef2abc0d7a50c980d82b429b59d Mon Sep 17 00:00:00 2001 From: UMTS at Teleco Date: Sun, 8 Mar 2026 17:15:45 +0100 Subject: Branch name change, working on fixing up documentation --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 41 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7da4399..7ac8024 100644 --- a/README.md +++ b/README.md @@ -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"
> -- 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) +
+![ScreenshotTUI1](https://git.teleco.ch/crt/hoardom.git/plain/doc/pics/image.png?h=main) +
-## 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) -![CUCKKOM](https://git.teleco.ch/crt/hoardom.git/plain/doc/pics/image.png?h=main =25%x) +## 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!
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 + +``` + +>
- +> **_Question:_** Whats the like main use for this tool?
+> -**_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.
‎ +> + +>
- +> **_Question:_** I dont need GUI all I want is a simple command?
- +> **_Answer:_** Ofcourse! That was the initial idea, simply type :
+> --> `hoardom somedomain.com` to see if a specific domain is free
+> --> `hoardom somedomain` to check which top 100ish tlds are free
+> --> `hoardom -l all -a somedomain` to check all 600ish registerable domain names and explicitly show which ones are already taken
‎
- +> **_Note:_** If you need stuff like csv outputs or other silly features check [the CLi docs](doc/CLI.md)
‎ + -## Quick Q & A `hoardom`? (tldr) -- cgit v1.2.3-70-g09d2