Skip to content

Commit f40583c

Browse files
committed
chore: update README
1 parent a48cec8 commit f40583c

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
# GitHub & GitLab Issues for Obsidian
22

3-
An Obsidian plugin that integrates with GitHub and GitLab to track issues and pull requests directly in your vault.
3+
![GitHub Release](https://img.shields.io/github/v/release/LonoxX/obsidian-github-issues)
4+
![GitHub License](https://img.shields.io/github/license/LonoxX/obsidian-github-issues)
5+
![GitHub Last Commit](https://img.shields.io/github/last-commit/LonoxX/obsidian-github-issues)
6+
![Release Workflow](https://img.shields.io/github/actions/workflow/status/LonoxX/obsidian-github-issues/release.yml?label=release)
7+
![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22github-issues%22%5D.downloads&url=https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/community-plugin-stats.json)
8+
![GitHub Stars](https://img.shields.io/github/stars/LonoxX/obsidian-github-issues)
9+
![GitHub Issues](https://img.shields.io/github/issues/LonoxX/obsidian-github-issues)
410

11+
An Obsidian plugin that integrates with GitHub and GitLab to track issues and pull requests directly in your vault.
512

6-
>The configurations are heavily inspired by https://github.com/schaier-io, including some specific settings. However, I had already started working on my prototype before I discovered the plugin, and had initially even given it a similar name.
13+
> The configurations are heavily inspired by https://github.com/schaier-io, including some specific settings. However, I had already started working on my prototype before I discovered the plugin, and had initially even given it a similar name.
714
815
# Documentation
16+
917
Check out the [documentation](https://github.com/LonoxX/obsidian-github-issues/wiki) for detailed information on setup, configuration, and usage.
1018

1119
## Features
1220

1321
### Issue & Pull Request Tracking
22+
1423
- Track issues and pull requests from multiple GitHub and GitLab repositories
1524
- Automatically sync data on startup (configurable)
1625
- Background sync at configurable intervals
@@ -19,27 +28,32 @@ Check out the [documentation](https://github.com/LonoxX/obsidian-github-issues/w
1928
- Automatic cleanup of old closed items
2029

2130
### GitLab Support
31+
2232
- Full support for GitLab Issues and Merge Requests
2333
- Works with self-hosted GitLab instances
2434
- Multiple GitLab instances can be configured simultaneously
2535

2636
### GitHub Projects v2 Integration
37+
2738
- Track GitHub Projects across repositories
2839
- Kanban board view for project visualization
2940
- Custom field support (status, priority, iteration)
3041
- Project-specific filtering and organization
3142

3243
### Sub-Issues Support
44+
3345
- Track sub-issues for both GitHub and GitLab (parent/child relationships)
3446
- Display sub-issues list with status indicators
3547
- Navigate between parent and child issues
3648
- Progress tracking with completion percentage
3749

3850
### Settings Profiles
51+
3952
- Central configuration for folders, templates, sync behaviour, and filters
4053
- Assign one profile to multiple repositories instead of configuring each one individually
4154

4255
### Markdown Notes
56+
4357
- Create markdown notes for each issue or PR
4458
- Customizable filename templates with variables
4559
- Custom content templates
@@ -63,18 +77,19 @@ Check out the [documentation](https://github.com/LonoxX/obsidian-github-issues/w
6377
3. Enable the plugin in **Community Plugins**
6478
4. Reload Obsidian
6579

66-
6780
## Configuration
6881

6982
### GitHub
83+
7084
1. Create a GitHub token with `repo` and `read:org` permissions
7185
[GitHub Settings > Developer Settings > Personal access tokens](https://github.com/settings/tokens)
72-
2. Paste the token in **Settings → GitHub & GitLab Issues → GitHub Token**
86+
2. Paste the token in **Settings - Providers - GitHub Token**
7387

7488
### GitLab
89+
7590
1. Create a GitLab Personal Access Token with `read_api` scope
7691
→ GitLab → Preferences → Access Tokens
77-
2. Enable the GitLab provider in **Settings Providers** and paste your token
92+
2. Enable the GitLab provider in **Settings - Providers - GitLab Token** and paste your token
7893

7994
## Adding Repositories
8095

0 commit comments

Comments
 (0)