swelog-cli 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,17 @@
|
|
|
1
|
-
|
|
1
|
+
<!-- markdownlint-disable MD033 MD041 -->
|
|
2
|
+
|
|
3
|
+
<h1 align="center">
|
|
4
|
+
<a href="https://swelog.rudrapatel.net/">
|
|
5
|
+
<br>
|
|
6
|
+
<img src="./assets/repository-banner.png" alt="Repository Banner" width="20%">
|
|
7
|
+
<br>
|
|
8
|
+
swelog-cli
|
|
9
|
+
</a>
|
|
10
|
+
</h1>
|
|
2
11
|
|
|
3
12
|
`swelog-cli` is a Rust CLI for tracking daily accomplishments in Obsidian.
|
|
4
13
|
|
|
5
|
-
Write notes as you work,
|
|
6
|
-
command. No API key required. Optional integrations pull in real activity, and an
|
|
7
|
-
optional LLM pass can summarize the notes for you.
|
|
14
|
+
Write notes as you work, fetch external data, and file it away with one command.
|
|
8
15
|
|
|
9
16
|
## Installation
|
|
10
17
|
|
|
@@ -22,30 +29,8 @@ swelog --help
|
|
|
22
29
|
|
|
23
30
|
## Getting Started
|
|
24
31
|
|
|
25
|
-
|
|
26
|
-
**[the swelog docs site](https://swelog-cli.vercel.app/)**, including:
|
|
27
|
-
|
|
28
|
-
- [Quick Start](https://swelog-cli.vercel.app/getting-started/quick-start/) —
|
|
29
|
-
configure your vault and file your first day
|
|
30
|
-
- [Configuration](https://swelog-cli.vercel.app/getting-started/configuration/)
|
|
31
|
-
— every field in `swelog.json`
|
|
32
|
-
- [Summarization](https://swelog-cli.vercel.app/summarization/) — the optional
|
|
33
|
-
LLM pass, weekly logs, and the Ollama, OpenAI, and OpenRouter providers
|
|
34
|
-
- [Integrations](https://swelog-cli.vercel.app/integrations/) — pull activity
|
|
35
|
-
from GitHub, Linear, and Google Calendar
|
|
36
|
-
- [Authentication](https://swelog-cli.vercel.app/reference/authentication/) —
|
|
37
|
-
how credentials are stored and cleared
|
|
38
|
-
- [Command reference](https://swelog-cli.vercel.app/reference/commands/) — the
|
|
39
|
-
full command tree
|
|
40
|
-
- [Privacy Policy](https://swelog-cli.vercel.app/legal/privacy/) and
|
|
41
|
-
[Terms of Service](https://swelog-cli.vercel.app/legal/terms/) — what stays on
|
|
42
|
-
your machine and what does not
|
|
43
|
-
|
|
44
|
-
## Contributing
|
|
45
|
-
|
|
46
|
-
Source, issues, and contributing guidelines live on
|
|
47
|
-
[GitHub](https://github.com/RudraPatel2003/swelog-cli).
|
|
32
|
+
Check out the [documentation](https://swelog.rudrapatel.net/) for more details.
|
|
48
33
|
|
|
49
34
|
## License
|
|
50
35
|
|
|
51
|
-
`swelog-cli` is released under the MIT License.
|
|
36
|
+
`swelog-cli` is released under the [MIT License](./LICENSE).
|