docs: improve readme and complete configuration options

Author: JonasToth

README.md

@@ -1,14 +1,17 @@
 # gitforge.nvim - Issues, PRs, CI/CD
 
-This plugin aims to provide integrated access to various Git Forges for your daily development
-tasks - working with issues, working with PRs and checking CI/CD pipelines.
-Its goal is being a workhorse plugin that is reliable and stable.
+- list, comment and change issues on GitLab and Github
+- pin relevant issues for you and have them available without searching for them
 
 > [!WARNING]
 > This plugin is in an early development state. Things may not work, they are clumsy and may break
 > randomly after an update.
 > Please keep this in mind.
 
+This plugin aims to provide integrated access to various Git Forges for your daily development
+tasks - working with issues, working with PRs and checking CI/CD pipelines.
+Its goal is being a workhorse plugin that is reliable and stable.
+
 You can read more about the goals and development milestones under [development resources](development_resources/README.md).
 
 ## Installation
@@ -122,7 +125,7 @@ See [docs/configuration.md](docs/configuration.md) for more information on how t
 
 ### General Capabilities
 
-- [ ] Project Specific configuration to use different backends for different repositories
+- [x] Project Specific configuration to use different backends for different repositories
 - [x] Proper Commands for more efficient lazy loading
 
 ### Issues

docs/configuration.md

@@ -8,11 +8,33 @@ The out-of-the-box experience will use Github.
 General settings that change the default experience:
 
 ```lua
+-- Timeout of provider-commands.
 M.opts.timeout = 3500
 -- one of:
 -- gh
 -- glab
 M.opts.default_issue_provider = "gh"
+-- Number of character after cut-off in telescope list view.
+M.opts.list_max_title_length = 60
+```
+
+## Project Settings
+
+It is possible to selectively configure specific directories to change their project setings.
+When creating the issue provider, all elements are searched in order. For the first entry that
+matches its `path` with `nvim`s current working directory is selected for configuration. Paths
+are expanded and normalized before matching. Matching is done on a prefix-searching.
+
+```lua
+-- Only 'path' is mandatory. At least one more other element should be provided to have an effect.
+opts.projects = {
+    -- Configure this project to use GitLab instead of Github.
+    { path = "~/software/my-project",   issue_provider = "glab" },
+    -- A clone of 'https://github.com/gl-cli/glab', that uses issues from 'https://gitlab.com/gitlab-org/cli'.
+    { path = "~/software/glab",         issue_provider = "glab", project = "gitlab.com/gitlab-org/cli" },
+    -- My own fork of LLVM, but issues are taken from the upstream repository.
+    { path = "~/software/llvm-project", issue_provider = "gh",   project = "github.com/llvm/llvm-project" },
+}
 ```
 
 ## Issue Settings
@@ -29,6 +51,7 @@ opts.issue_keys = {
     assignees = "<localleader>a"
     description = "<localleader>d"
     state = "<localleader>s"
+    pin = "<localleader>p"
     webview = "<localleader>w"
 }
 ```