From: Steven Black Date: Sat, 23 Jan 2021 02:51:26 +0000 (-0500) Subject: Minor edits to the readme_template. X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=a946fb96c8e20abd7795b13da459808b240ff890;p=stevenblack-hosts.git Minor edits to the readme_template. --- diff --git a/readme_template.md b/readme_template.md index 8eaf23884..cc5ab5508 100644 --- a/readme_template.md +++ b/readme_template.md @@ -1,7 +1,7 @@ ----- **Take Note!** * With the exception of issues and PRs regarding changes to `hosts/data/StevenBlack/hosts`, all other issues regarding the content of the produced hosts files should be made with the appropriate data source that contributed the content in question. The contact information for all of the data sources can be found in the `hosts/data/` directory. + ---- ![Logo](https://raw.githubusercontent.com/StevenBlack/hosts/master/.github/logo.png) @@ -25,7 +25,6 @@ into a unified hosts file with duplicates removed. A variety of tailored hosts * Here's the [raw hosts file @EXTENSIONS_HEADER@](https://raw.githubusercontent.com/StevenBlack/hosts/master/@SUBFOLDER@hosts) containing @NUM_ENTRIES@ entries. * Logo by [@Tobaloidee](https://github.com/Tobaloidee). - ## List of all hosts file variants This repository offers [15 different host file variants](https://github.com/StevenBlack/hosts/tree/master/alternates), in addition to the base variant. @@ -50,7 +49,6 @@ Host file source | Description | Home page | Raw hosts | Update frequency | Lice -----------------|-------------|:---------:|:---------:|:----------------:|:-------:|:------: @SOURCEROWS@ - ## Extensions The unified hosts file is optionally extensible. Extensions are used to include domains by category. Currently, we offer the following categories: `fakenews`, `social`, `gambling`, and `porn`. @@ -71,13 +69,13 @@ The container will contain Python 3 and all its dependency requirements, and a c Build the Docker container like this: -``` +```sh docker build ./ ``` Access the terminal like this: -``` +```sh docker run -it (containerid) bash ``` @@ -85,7 +83,6 @@ docker run -it (containerid) bash To generate your own amalgamated hosts files you will need Python 3.5 or later. - First, install the dependencies with: ```sh @@ -189,7 +186,6 @@ To install hosts file on your machine add the following into your `configuration * NOTE: The call to `fetchurl` is impure. Use `fetchFromGitHub` with the exact commit if you want to always get the same result. - ## How do I control which sources are unified? Add one or more *additional* sources, each in a subfolder of the `data/` @@ -248,7 +244,6 @@ Then, submit a pull request. If you're able to curate your own collection of sketchy domains, then curate your own hosts list. Then signal the existence of your repo as [a new issue](https://github.com/StevenBlack/hosts/issues) and we may include your new repo into the collection of sources we pull whenever we create new versions. - ## What is a hosts file? A hosts file, named `hosts` (with no file extension), is a plain-text file @@ -287,7 +282,6 @@ interfere with a web server that may be running on the local PC. We tried that. Using `0` doesn't work universally. - ## Location of your hosts file To modify your current `hosts` file, look for it in the following places and modify it with a text