Skip to content

Commit bc0c4ae

Browse files
committed
docs: add badges and homebrew installation
1 parent 58bd577 commit bc0c4ae

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# obsync
22

3+
[![release](https://github.com/bpauli/obsync/actions/workflows/release.yml/badge.svg)](https://github.com/bpauli/obsync/actions/workflows/release.yml)
4+
[![Go Report Card](https://goreportcard.com/badge/github.com/bpauli/obsync)](https://goreportcard.com/report/github.com/bpauli/obsync)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
6+
37
A command-line tool for syncing [Obsidian](https://obsidian.md) vaults on headless Linux servers. Uses the official Obsidian Sync protocol over WebSocket with full end-to-end encryption.
48

59
Built for running Obsidian vaults on servers where the desktop app isn't available — perfect for automated workflows, CI/CD pipelines, or keeping a server-side copy of your notes.
@@ -17,26 +21,22 @@ Built for running Obsidian vaults on servers where the desktop app isn't availab
1721

1822
## Installation
1923

20-
### From Source
24+
### Homebrew (macOS / Linux)
2125

2226
```bash
23-
go install obsync@latest
27+
brew install bpauli/tap/obsync
2428
```
2529

2630
### Build from Source
2731

32+
Requires Go 1.25+.
33+
2834
```bash
2935
git clone https://github.com/bpauli/obsync.git
3036
cd obsync
3137
go build -o obsync ./cmd/obsync
3238
```
3339

34-
Set version info at build time:
35-
36-
```bash
37-
go build -ldflags "-X obsync/internal/cmd.version=1.0.0 -X obsync/internal/cmd.commit=$(git rev-parse --short HEAD) -X obsync/internal/cmd.date=$(date -u +%Y-%m-%d)" -o obsync ./cmd/obsync
38-
```
39-
4040
## Quick Start
4141

4242
### 1. Log in

0 commit comments

Comments
 (0)