From 70d961ab83ce045a67abc2d7ccc603c61c9ab737 Mon Sep 17 00:00:00 2001 From: loyalsoldier <10487845+Loyalsoldier@users.noreply.github.com> Date: Sun, 19 Jul 2020 09:31:08 +0800 Subject: [PATCH 1/2] README: change sources from v2ray to v2fly --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d88e0750..361ababf 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ This project is not opinionated. In other words, it does NOT endorse, claim or i ## Download links -- **dlc.dat**：[https://github.com/v2ray/domain-list-community/raw/release/dlc.dat](https://github.com/v2ray/domain-list-community/raw/release/dlc.dat) -- **dlc.dat.sha256sum**：[https://github.com/v2ray/domain-list-community/raw/release/dlc.dat.sha256sum](https://github.com/v2ray/domain-list-community/raw/release/dlc.dat.sha256sum) +- **dlc.dat**：[https://github.com/v2fly/domain-list-community/raw/release/dlc.dat](https://github.com/v2fly/domain-list-community/raw/release/dlc.dat) +- **dlc.dat.sha256sum**：[https://github.com/v2fly/domain-list-community/raw/release/dlc.dat.sha256sum](https://github.com/v2fly/domain-list-community/raw/release/dlc.dat.sha256sum) ## Usage example @@ -67,7 +67,7 @@ Each file in the `data/` directory can be used as a rule in this format: `geosit ## Generate `dlc.dat` manually - Install `golang` and `git` -- Download and install project code: `go get -u -v --insecure github.com/v2ray/domain-list-community` +- Download and install project code: `go get -u -v --insecure github.com/v2fly/domain-list-community` - Generate `dlc.dat` (without `datapath` option means to use `data` directory of this repository in `$GOPATH`): - `$(go env GOPATH)/bin/domain-list-community` - `$(go env GOPATH)/bin/domain-list-community --datapath=/path/to/your/custom/data/directory` @@ -104,10 +104,10 @@ To generate a section: 1. Remove all the comments in the file. 2. Replace `include:` lines with the actual content of the file. 3. Omit all empty lines. -4. Generate each `domain:` line into a [sub-domain routing rule](https://github.com/v2ray/v2ray-core/blob/master/app/router/config.proto#L21). -5. Generate each `keyword:` line into a [plain domain routing rule](https://github.com/v2ray/v2ray-core/blob/master/app/router/config.proto#L17). -6. Generate each `regex:` line into a [regex domain routing rule](https://github.com/v2ray/v2ray-core/blob/master/app/router/config.proto#L19). -7. Generate each `full:` line into a [full domain routing rule](https://github.com/v2ray/v2ray-core/blob/master/app/router/config.proto#L23). +4. Generate each `domain:` line into a [sub-domain routing rule](https://github.com/v2fly/v2ray-core/blob/master/app/router/config.proto#L21). +5. Generate each `keyword:` line into a [plain domain routing rule](https://github.com/v2fly/v2ray-core/blob/master/app/router/config.proto#L17). +6. Generate each `regex:` line into a [regex domain routing rule](https://github.com/v2fly/v2ray-core/blob/master/app/router/config.proto#L19). +7. Generate each `full:` line into a [full domain routing rule](https://github.com/v2fly/v2ray-core/blob/master/app/router/config.proto#L23). ## How to organize domains From 5135b865c7448e4cf9e7c662097bbcfe6274a90e Mon Sep 17 00:00:00 2001 From: loyalsoldier <10487845+Loyalsoldier@users.noreply.github.com> Date: Sun, 19 Jul 2020 09:42:31 +0800 Subject: [PATCH 2/2] README: fix typo and refine expression and markdown format --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 361ababf..eff8a556 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This project is not opinionated. In other words, it does NOT endorse, claim or i ## Usage example -Each file in the `data/` directory can be used as a rule in this format: `geosite:filename`. +Each file in the `data` directory can be used as a rule in this format: `geosite:filename`. ```json "routing": { @@ -74,18 +74,18 @@ Each file in the `data/` directory can be used as a rule in this format: `geosit ## Structure of data -All data are under `data/` directory. Each file in the directory represents a sub-list of domains, named by the file name. File content is in the following format. +All data are under `data` directory. Each file in the directory represents a sub-list of domains, named by the file name. File content is in the following format. ``` # comments include:another-file -domain:google.com @attr1 @att2 +domain:google.com @attr1 @attr2 keyword:google regex:www\.google\.com full:www.google.com ``` -Syntax: +**Syntax:** * Comment begins with `#`. It may begin anywhere in the file. The content in the line after `#` is treated as comment and ignored in production. * Inclusion begins with `include:`, followed by the file name of an existing file in the same directory. @@ -97,7 +97,7 @@ Syntax: ## How it works -The entire data directory will be built into an external `geosite` file for Project V. Each file in the directory represents a section in the generated file. +The entire `data` directory will be built into an external `geosite` file for Project V. Each file in the directory represents a section in the generated file. To generate a section: @@ -117,7 +117,7 @@ Theoretically any string can be used as the name, as long as it is a valid file ### Attributes -Attribute is useful for sub-group of domains, especially for filtering purpose. For example, the list of "google" domains may contains its main domains, as well as domains that serve ads. The ads domains may be marked by attribute "@ads", and can be used as "geosite:google@ads" in V2Ray routing. +Attribute is useful for sub-group of domains, especially for filtering purpose. For example, the list of `google` domains may contains its main domains, as well as domains that serve ads. The ads domains may be marked by attribute `@ads`, and can be used as `geosite:google@ads` in V2Ray routing. ## Contribution guideline