Skip to content

Commit 4ae8682

Browse files
committed
Add badges, CONTRIBUTING.md, improve README discoverability
1 parent 79b42ca commit 4ae8682

2 files changed

Lines changed: 55 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing to Librarr
2+
3+
Thanks for your interest in contributing! Here's how to get started.
4+
5+
## Quick Start
6+
7+
```bash
8+
git clone https://github.com/JeremiahM37/librarr.git
9+
cd librarr
10+
go build -o librarr ./cmd/librarr/
11+
go test ./...
12+
```
13+
14+
## Good First Issues
15+
16+
Check the [good first issue](https://github.com/JeremiahM37/librarr/labels/good%20first%20issue) label for beginner-friendly tasks.
17+
18+
## How to Contribute
19+
20+
1. Fork the repo
21+
2. Create a branch (`git checkout -b feature/my-feature`)
22+
3. Make your changes
23+
4. Run tests (`go test ./...`)
24+
5. Commit and push
25+
6. Open a Pull Request
26+
27+
## Code Style
28+
29+
- Standard Go formatting (`gofmt`)
30+
- Table-driven tests with `t.Run()`
31+
- Mock HTTP calls with `httptest.NewServer`
32+
- No external test frameworks — just `testing`
33+
34+
## Adding a Search Source
35+
36+
1. Create `internal/search/yoursource.go` implementing the `Source` interface
37+
2. Add it to the source registry in `internal/search/searcher.go`
38+
3. Add config vars in `internal/config/config.go`
39+
4. Write tests in `internal/search/yoursource_test.go`
40+
41+
## Areas That Need Help
42+
43+
- **Security audit** — review HTTP clients for SSRF/injection (#4)
44+
- **New search sources** — more book/audiobook/manga sources
45+
- **UI improvements** — the web UI is functional but minimal
46+
- **Documentation** — guides for specific setups (Readarr integration, Calibre-Web, etc.)
47+
48+
## License
49+
50+
By contributing, you agree that your contributions will be licensed under GPL-3.0.

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Librarr
22

3+
[![Build & Test](https://github.com/JeremiahM37/librarr/actions/workflows/test.yml/badge.svg)](https://github.com/JeremiahM37/librarr/actions/workflows/test.yml)
4+
[![Release](https://img.shields.io/github/v/release/JeremiahM37/librarr?include_prereleases)](https://github.com/JeremiahM37/librarr/releases)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/JeremiahM37/librarr)](https://goreportcard.com/report/github.com/JeremiahM37/librarr)
6+
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
7+
38
**The missing *arr for books.** Self-hosted book, audiobook, and manga search and download manager — like Sonarr/Radarr but for your reading library.
49

510
Librarr searches 13 sources simultaneously, scores results by confidence, and auto-imports into your Calibre, Audiobookshelf, Kavita, or Komga library. Single 17MB Go binary. No runtime dependencies.

0 commit comments

Comments
 (0)