Skip to content

Commit d7c189b

Browse files
committed
docs: Update README
1 parent 74f3d86 commit d7c189b

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This plugin for [Obsidian][Obsidian] imports your GitHub stars into your vault as separate documents. So, when import is done you will be able to:
44
- Create [internal links](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Internal%20links) to your starred repositories in your vault
5-
- See a history of your stars activity
6-
- Have a index of your starred repositories groupped by programming languages
7-
- Have a index groupped by owners of your starred repos
5+
- See a history of your stars on GitHub
6+
- Have a index of your starred repositories grouped by programming languages
7+
- Have a index grouped by owners of your starred repos
88

99
## Demo
1010

@@ -47,16 +47,17 @@ TODO
4747
## Roadmap to 1.0
4848

4949
- [x] Automatically remove files related to removed stars
50-
- [ ] i18n
50+
- [x] Incremental update
5151
- [ ] Use Obsidian views to:
52-
- [ ] Statistics
53-
- [ ] Full text search
54-
- [ ] Ratings
55-
- [ ] Incremental update
52+
- [ ] Make a full text search
53+
- [ ] Show statistics
54+
- [ ] Show ratings
55+
- [ ] i18n / l10n
5656
- [ ] Fetch README file content on a starred repository page
57-
- [ ] Fetch owner's bio or organization information on owner's page
5857
- [ ] Global changes log
59-
- [ ] Highlight archived or deprecated/unmaintined repositories
58+
- [ ] Highlight archived, deprecated and unmaintained repositories
59+
- [ ] Customizable templates of pages
60+
- [ ] Test suite
6061

6162
## Implementation details
6263

@@ -66,7 +67,10 @@ TODO
6667
- [SQL.js][SQL.js] (SQLite in browser via WASM)
6768
- [octokit.js][octokit.js] (API client for GitHub)
6869
- [Handlebars][Handlebars] (Templates for pages)
70+
- [neverthrow][neverthrow] (unified error handling and result types)
71+
- [luxon][luxon] (date and time library)
6972
- [Biome][Biome] (lint, format, etc)
73+
- [git-cliff][git-cliff] (bump versions and change log generation)
7074

7175
## Inspiration sources
7276

@@ -80,4 +84,7 @@ TODO
8084
[Biome]: https://biomejs.dev/
8185
[SQL.js]: https://sql.js.org
8286
[octokit.js]: https://github.com/octokit/octokit.js
87+
[neverthrow]: https://github.com/softprops/neverthrow
88+
[luxon]: https://moment.github.io/luxon/
8389
[Handlebars]: https://handlebarsjs.com
90+
[git-cliff]: https://git-cliff.org/

0 commit comments

Comments
 (0)