chore(config): update default description with instructions for priva…

…te repos (#27) * chore: Add disclaimer to README * chore(config): update default description with instructions for private repos On private repos, st needs the full `repo` scope to work properly--else you'll get a 404. It should say so in the config --------- Co-authored-by: clabby <[email protected]>
clabby · Oct 24, 2024 · d295967 · d295967
1 parent ccb54d5
commit d295967
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/config.rs b/src/config.rs
@@ -11,6 +11,8 @@ pub(crate) const DEFAULT_CONFIG_PRETTY: &str = r#"# GitHub personal access token
 # Must have the following scopes:
 # - repo:status
 # - repo:public_repo
+#
+# If you're planning to use st with private repositories, you'll need to add the full `repo` scope.
 github_token = """#;
 
 #[derive(Default, Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]