Skip to content

Commit 6297ed0

Browse files
committed
docs: update README
1 parent 7327f4a commit 6297ed0

1 file changed

Lines changed: 22 additions & 19 deletions

File tree

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,71 +5,74 @@ An Obsidian plugin that integrates with GitHub to track issues and pull requests
55

66
>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.
77
8-
## ✨ Features
8+
# Documentation
9+
Check out the [documentation](https://github.com/LonoxX/obsidian-github-issues/wiki) for detailed information on setup, configuration, and usage.
910

10-
### 🔄 Issue & Pull Request Tracking
11+
## Features
12+
13+
### Issue & Pull Request Tracking
1114
- Track issues and pull requests from multiple GitHub repositories
1215
- Automatically sync GitHub data on startup (configurable)
1316
- Background sync at configurable intervals
1417
- Filter by labels, assignees, and reviewers
1518
- Include or exclude closed issues/PRs
1619
- Automatic cleanup of old closed items
1720

18-
### 📊 GitHub Projects v2 Integration
21+
### GitHub Projects v2 Integration
1922
- Track GitHub Projects across repositories
2023
- Kanban board view for project visualization
2124
- Custom field support (status, priority, iteration)
2225
- Project-specific filtering and organization
2326

24-
### 🔗 Sub-Issues Support
27+
### Sub-Issues Support
2528
- Track GitHub sub-issues (parent/child relationships)
2629
- Display sub-issues list with status indicators
2730
- Navigate between parent and child issues
2831
- Progress tracking with completion percentage
2932

30-
### 📝 Markdown Notes
33+
### Markdown Notes
3134
- Create markdown notes for each issue or PR
3235
- Customizable filename templates with variables
3336
- Custom content templates
3437
- YAML frontmatter with metadata
3538
- Preserve user content with persist blocks
3639
- Include comments in notes
3740

38-
## 🚀 Installation
41+
## Installation
42+
43+
### Via Community Plugins (Recommended)
3944

40-
### Via Obsidian Community Plugins
41-
1. Open Obsidian settings
45+
1. Open Obsidian Settings
4246
2. Navigate to **Community Plugins**
4347
3. Click **Browse** and search for "GitHub Issues"
4448
4. Click **Install** and then **Enable**
4549

4650
### Manual Installation
4751

48-
1. Download the latest release from the [GitHub Releases page](https://github.com/LonoxX/obsidian-github-issues/releases).
49-
2. Extract the contents into your Obsidian plugins folder:
50-
`<vault>/.obsidian/plugins/github-issues/`
51-
3. Enable the plugin in Obsidian under **Community Plugins**
52-
4. Reload or restart Obsidian
52+
1. Download the latest release from [GitHub Releases](https://github.com/LonoxX/obsidian-github-issues/releases)
53+
2. Extract to `<vault>/.obsidian/plugins/github-issues/`
54+
3. Enable the plugin in **Community Plugins**
55+
4. Reload Obsidian
5356

54-
## ⚙️ Configuration
57+
58+
## Configuration
5559

5660
1. Create a new GitHub token with the `repo` and `read:org` permissions
5761
[GitHub Settings > Developer Settings > Personal access tokens](https://github.com/settings/tokens)
5862
2. Configure the plugin in Obsidian settings:
5963
- Paste your GitHub token in the **GitHub Token** field
6064
- Adjust additional settings as needed
6165

62-
## 📦 Adding Repositories
66+
## Adding Repositories
6367

6468
1. Open the plugin settings in Obsidian
6569
2. Add repositories by entering the full GitHub repository path (e.g., `lonoxx/obsidian-github-issues`),
6670
or use the repository browser to select one or multiple repositories
6771
3. Click **Add Repository** or **Add Selected Repositories**
6872
4. The plugin will automatically fetch issues from the configured repositories
6973

70-
### ⭐ This repository if you like this project!
71-
74+
## Support
7275

73-
## 📄 License
76+
If you find this plugin useful and would like to support its development, you can star the repository or support me on Ko-fi or [GitHub Sponsors](https://github.com/sponsors/LonoxX):
7477

75-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
78+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/LonoxX)

0 commit comments

Comments
 (0)