Commit Graph

43 Commits

Author SHA1 Message Date
William Melody 23d6a1c653 Move completion installation into the main script. 2020-06-07 13:20:12 -07:00
William Melody 9dab3606c6 Add exit status documentation to README.md 2020-04-22 12:08:02 -07:00
William Melody 972dc9a752 Improve README.md 2020-04-14 13:17:18 -07:00
William Melody 95807387a1 Improve README.md 2020-04-14 13:16:29 -07:00
William Melody 89b016999d Remove duplicate heading in README.md 2020-04-14 13:05:47 -07:00
William Melody 91946962a6 Fix heading level in README.md 2020-04-14 13:03:37 -07:00
William Melody 45b39d1bc7 Update README.md 2020-04-14 10:10:20 -07:00
William Melody 3d65bccdb5 Manage completion with `scripts/hosts-completion`. 2020-04-14 09:26:53 -07:00
William Melody 809bb45121 Update heading in README.md 2020-04-13 16:37:45 -07:00
William Melody 638da3200e Reconfigure completion setup. 2020-04-13 16:36:58 -07:00
William Melody b9a257f5d5 Add Travis status image to README.md 2020-04-12 19:09:30 -07:00
William Melody 33c5aa1c3c Modify example in README.md 2020-04-08 21:36:52 -07:00
William Melody c23a00bc49 Add walkthrough to README.md 2020-04-08 21:26:21 -07:00
William Melody d772e7c13e Avoid long lines in README.md 2020-04-08 17:47:53 -07:00
William Melody b44b69f83d Use simpler homebrew install command in README.md. 2020-03-24 15:03:40 -07:00
William Melody 925de9dca5 Update GitHub username.
alphabetum -> xwmx
2020-03-18 12:02:45 -07:00
William Melody 92f0e97073 Link to the package name on npmjs.com. 2020-03-16 15:05:21 -07:00
William Melody 13171f4a01 Swap installation methods in README.md. 2020-03-16 15:05:21 -07:00
William Melody 916009280e Update bpkg URL in README.md. 2020-03-16 15:05:21 -07:00
William Melody e858faec05 Add npm install to README.md. 2020-03-16 15:05:21 -07:00
William Melody 091e1c3809
Use non-mobile Wikipedia URL in README.md. 2020-03-15 20:37:05 -07:00
William Melody 659bbb4755 Use consistent argument name in documentation. 2020-03-15 18:51:42 -07:00
William Melody 0247826a41 Indicate in help text that `--skip-backup` is optional. 2020-03-15 18:49:03 -07:00
William Melody 09dad21311 Remove extra backslashes from README.md. 2020-03-15 18:46:59 -07:00
William Melody 4eed5251da Add `backups` command.
`backups` provides subcommands for managing backups of the hosts file.
2020-03-15 18:42:16 -07:00
William Melody ada8cb6019 Handle multiple hostnames with `block` and `unblock`. 2020-03-15 17:10:29 -07:00
William Melody a475dc53aa
Add hosts file wikipedia link to README.md 2018-12-31 17:47:32 -08:00
William Melody b44f3b8fe0
Update description in README.md 2018-08-14 11:24:51 -07:00
William Melody 500d0f9b7f
Update description in README.md 2018-08-14 10:48:55 -07:00
{ɑβ} 899783e72d
Add link to AUR package in README.md 2018-05-15 10:06:02 -07:00
{ɑβ} b242081ef1
Add blocklists to README.md 2017-12-31 09:02:09 -08:00
William Melody 17a4eb1890 Use heading 3 for all command names in README.md. 2017-04-06 10:48:04 -07:00
William Melody 6c0254895f Support full `list` operations in `hosts` with no subcommand. 2017-03-01 20:18:26 -08:00
William Melody 7919b171fe Fix typo in README.md. 2017-03-01 16:26:58 -08:00
William Melody c3cee7c65d Simplify README.md links. 2017-03-01 16:24:10 -08:00
William Melody 99b175f134 Add `--auto-sudo` option and expand option documentation.
Using `sudo` within a script is generally considered poor practice, so
by default an error message is printed when the user attempts to perform
a write operation without sufficient permissions.

One way to deal avoid this error message is to alias `hosts` to `sudo
hosts`, but this then requires `sudo` for all operations and not just
write operations.

The new `--auto-sudo` option flag provides a way to automatically invoke
a write command with `sudo` when the user doesn't have write
permissions.

In order to provide cleaner documentation for this option, include more
option documentation in README.md.
2017-03-01 16:18:05 -08:00
William Melody 0bb87f92fe Expand help documentation in README.md
Output formatted to markdown with:

    for __command in "$(hosts commands --raw)"
    do
      printf "### \`hosts %s\`\n" "${__command}"
      printf "\n"
      printf "\`\`\`text\n"
      hosts help "${__command}"
      printf "\`\`\`\n"
      printf "\n"
    done
2017-03-01 14:02:17 -08:00
William Melody 347189c059 Add `search` usage to primary `help` output.
Update README.md to more accurately reflect `help` output.
2017-03-01 13:45:19 -08:00
William Melody 265a1c732e Add `block` and `unblock` functions.
`block` and `unblock` set the given <hostname> to the IPv4 and IPv6
loopback addresses.
2017-03-01 13:43:10 -08:00
William Melody e8fa0d8ac8 Fix typos in README.md. 2017-03-01 12:49:36 -08:00
William Melody 73ffcffb38 Add `hosts search` function.
`hosts search` wraps `hosts list`, providing a slightly more intuitive
interface.
2017-03-01 12:46:27 -08:00
William Melody e9f3dc5431 Add "Tests" section to README.md. 2017-03-01 12:15:16 -08:00
William Melody f4ebb9468a Rename "Readme.md" to "README.md". 2017-03-01 11:39:43 -08:00