prehistoric-systems/FilterLists
1
0
Fork 0
mirror of https://github.com/collinbarrett/FilterLists.git synced 2026-03-11 09:04:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs update

Browse source
This commit is contained in:
Collin M. Barrett 2018-02-14 13:15:45 -06:00
parent c9f078061d
commit 6bdf025f19
1 changed files with 3 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
.github/README.md vendored
View file

@ -15,51 +15,11 @@ FilterLists is the independent and comprehensive directory of all public filter
| [v2 (Stable, Frozen)](https://filterlists.com/) | |
| [v1 (Legacy, Frozen)](https://v1.filterlists.com/) | |
## Submitting or Updating Lists
To suggest a new list or update the information of an existing list, create a PR against [data](https://github.com/collinbarrett/FilterLists/tree/master/data) or open a new [Issue](https://github.com/collinbarrett/FilterLists/issues). Provide all of the information in the Properties section below that is available.
## Development Notice (Updated February 12, 2018)
## Development Notice (Updated February 14, 2018)
FilterLists improvements are slow and tend to be in spurts. I care about this project as both a resource for the community and a learning tool for me. However, my day job comes first which often results in little to no work on the project at times. I happily welcome anyone that wants to contribute.
The immediate projects are converting the data to an actual web application (rather than Google Sheets & WordPress), and then exposing the data via a .Net Core REST API driving a first-party ReactJS UI.
### Help Wanted
## Adding or Updating Lists
- Updating the [data](https://github.com/collinbarrett/FilterLists/tree/master/data)
- Building the new API-driven front-end ([FilterLists.Web](https://github.com/collinbarrett/FilterLists/tree/master/src/FilterLists.Web)). The current direction is a [ReactJS](https://reactjs.org/) API-driven UI with (possibly) [ANT](https://ant.design/) controls. I am not a front-end developer, so I would happily welcome any assistance. Early preview is deployed [here](https://beta.filterlists.com/).
## Properties
*Asterisks indicate a foreign key relationship.
### FilterLists (mapped to [FilterList](https://github.com/collinbarrett/FilterLists/blob/master/src/FilterLists.Data/Entities/FilterList.cs))
| Property | Description |
|----------------------|--------------------------------------------------------------------------|
| Description | The list's functionality |
| DescriptionSourceUrl | The list's Description source URL if quoted directly |
| DiscontinuedDate | The list's date of discontinuation as expressed by the maintainer |
| DonateUrl | The list's donation URL |
| EmailAddress | The list's email address |
| ForumUrl | The list's forum URL |
| HomeUrl | The list's home page URL |
| IssuesUrl | The list's GitHub Issues URL |
| *Languages | The list's target languages |
| *License | The list's license (typically [CC](https://creativecommons.org/choose/)) |
| *Maintainers | The list's maintainers |
| Name | The list's name (APA Title Case) |
| PolicyUrl | The list's policy/guidelines for the types of rules it contains |
| SubmissionUrl | The list's submission form URL |
| *Syntax | The list's syntax (uBlock Origin, Adblock Plus, hosts, etc.) |
| *UpstreamFilterLists | The list's upstream lists if it is a fork or a merge |
| ViewUrl | The list's view/download URL (typically .txt file) |
### Maintainers (mapped to [Maintainer](https://github.com/collinbarrett/FilterLists/blob/master/src/FilterLists.Data/Entities/Maintainer.cs))
| Property | Description |
|---------------|--------------------------------------------|
| EmailAddress | The maintainer's email address |
| HomeUrl | The maintainer's home page URL |
| Name | The maintainer's name |
| TwitterHandle | The maintainer's Twitter handle |
| *FilterLists | The maintainer's lists |
To submit a new list or update data about an existing list, please submit a pull request to [data](https://github.com/collinbarrett/FilterLists/tree/master/data) in conjunction with the data model described [here](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar). Alternatively, you can [open a new issue](https://github.com/collinbarrett/FilterLists/issues/new) providing information for all of the fields described in the [data model](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar).