Skip to content

Commit 3a65244

Browse files
committed
fix ci/cd - add readme
1 parent 2ca1e17 commit 3a65244

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Scriberr
2+
3+
Ever wished you could just record something and get an accurate transcript with speaker identification? That's exactly what Scriberr does.
4+
5+
## What is this?
6+
7+
Scriberr is a web app that takes your audio files and turns them into detailed transcripts. It uses WhisperX under the hood, so you get:
8+
9+
- **Accurate transcription** - WhisperX is really good at this
10+
- **Speaker diarization** - It figures out who said what
11+
- **Multiple formats** - Get your transcript as text, SRT, VTT, or JSON
12+
- **Chat with your audio** - Ask questions about what was said using AI
13+
- **Take notes** - Annotate important parts as you listen
14+
15+
## Quick start
16+
17+
The easiest way to get started:
18+
19+
```bash
20+
brew tap rishikanthc/scriberr
21+
brew install scriberr
22+
```
23+
24+
Then just run `scriberr` and open http://localhost:8080 in your browser.
25+
26+
## What you can do
27+
28+
- Upload audio files or record directly in the app
29+
- Get transcripts with timestamps and speaker labels
30+
- Download transcripts in whatever format you need
31+
- Chat with AI about your recordings
32+
- Create summaries of long audio
33+
- Manage everything through a clean web interface
34+
35+
## Requirements
36+
37+
- Python 3.11+ (for the transcription engine)
38+
- A few GB of disk space for the AI models
39+
40+
That's it. Everything else is handled for you.
41+
42+
## Built with
43+
44+
Go backend, React frontend, WhisperX for transcription, and a lot of coffee.

0 commit comments

Comments
 (0)