summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorSoniEx2 <endermoneymod@gmail.com>2020-11-07 13:43:58 -0300
committerSoniEx2 <endermoneymod@gmail.com>2020-11-07 13:43:58 -0300
commitdb85f92e9b77c691f25f3109e5040e03e7b1319c (patch)
treead75331d81d11533e89b77dd8153f7eef1d20a27 /README.md
parentdcdcc839352613d67937eda6d5a4f13097b1793e (diff)
Add non-federating repos
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.md b/README.md
index 5e52034..1029339 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ is stored in the XDG data home, as per the XDG Base Directory specification.
 Then create or edit the file `$XDG_CONFIG_HOME/ganarchy/config.toml`. It
 can contain the following items, some of which are required:
 
-```
+```toml
 # Example GAnarchy config
 
 # The base_url is the web address of the GAnarchy instance.
@@ -34,24 +34,27 @@ title = "GAnarchy on autistic.space"
 # used.
 [repo_list_srcs]
 # Each repo list src is an URL that points to the repo list.
-# Restrictions: active MUST be present. MUST be https.
+# Restrictions: active MUST be present. MUST be https or file.
 "https://ganarchy.autistic.space/index.toml" = { active=true }
 # active=false won't be processed.
-"https://ganarchy.github.io/index.toml" = { active=true }
+"https://ganarchy.github.io/index.toml" = { active=false }
 
 # The projects table is made up of "project commit" hashes (see below for
 # what a project commit is)
 [projects.385e734a52e13949a7a5c71827f6de920dbfea43]
 # Each project is made up of repos and branches
 # HEAD is special and refers to the default branch
-# Restrictions: active MUST be present, file URLs are disallowed.
+# Restrictions: active MUST be present. MUST be https.
 "https://cybre.tech/SoniEx2/ganarchy".HEAD = { active=true }
 # repos/branches with active=false will not be shown or updated.
 "https://cybre.tech/SoniEx2/ganarchy".broken = { active=false }
+# federate=false won't be shared with other instances, but will be shown and
+# updated. (handy if you don't fully trust a repo yet.)
+"https://soniex2.autistic.space/git-repos/ganarchy.git"."feature/new-config" = { active=true, federate=false }
 ```
 
-A project commit is a commit that *must* start with `[Project]` followed by the
-project name, and may have an optional description.
+A project commit is a commit whose message MUST start with `[Project]`
+followed by the project name, and may have an optional description.
 
 Example project commit: