Skip to content

Commit 27a3058

Browse files
committed
docs: add RELEASE.md and README.md, update release workflow
1 parent b0a35bc commit 27a3058

File tree

3 files changed

+100
-0
lines changed

3 files changed

+100
-0
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ jobs:
8080
with:
8181
files: |
8282
./artifacts/datailama-*
83+
body_path: RELEASE.md
8384
draft: false
8485
prerelease: false
8586
generate_release_notes: true

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# DataILama
2+
3+
DataILama is a tool for managing and analyzing research papers using AI. It provides a web interface and API for searching, analyzing, and managing academic papers.
4+
5+
## Features
6+
7+
- Web interface for paper management
8+
- AI-powered paper analysis
9+
- REST API for programmatic access
10+
- Vector search capabilities
11+
12+
## Installation
13+
14+
### From Release
15+
16+
1. Download the latest release from the [releases page](https://github.com/hydrocode-de/datailama/releases)
17+
2. Choose the appropriate binary for your system
18+
3. Make it executable (Linux/macOS):
19+
```bash
20+
chmod +x datailama-<os>-<arch>
21+
```
22+
4. Run the server:
23+
```bash
24+
./datailama-<os>-<arch> serve
25+
```
26+
27+
### From Source
28+
29+
1. Clone the repository:
30+
```bash
31+
git clone https://github.com/hydrocode-de/datailama.git
32+
cd datailama
33+
```
34+
35+
2. Build the frontend:
36+
```bash
37+
cd frontend
38+
npm install
39+
npm run build
40+
cd ..
41+
```
42+
43+
3. Build the Go binary:
44+
```bash
45+
go build
46+
```
47+
48+
4. Run the server:
49+
```bash
50+
./datailama serve
51+
```
52+
53+
## Configuration
54+
55+
The server can be configured using environment variables or command-line flags:
56+
57+
- `DATAILAMA_PORT`: Port to listen on (default: 8080)
58+
- `DATAILAMA_DB_URL`: Database connection URL
59+
- `DATAILAMA_OLLAMA_URL`: Ollama server URL
60+
61+
## Development
62+
63+
### Prerequisites
64+
65+
- Go 1.23 or later
66+
- Node.js 20 or later
67+
- PostgreSQL database
68+
- Ollama server
69+
70+
### Running Tests
71+
72+
```bash
73+
# Build frontend
74+
cd frontend && npm install && npm run build && cd ..
75+
76+
# Run Go tests
77+
go test -v ./...
78+
```

RELEASE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# DataILama v{{version}}
2+
3+
## Description
4+
DataILama is a powerful data management tool that connects your vector databases with local LLM instances through Ollama or cloud instances. It provides a simple CLI interface to manage your data collections and interact with them through a REST API.
5+
6+
## Installation
7+
Download the appropriate binary for your system from the release assets and make it executable:
8+
```bash
9+
# For Linux/macOS
10+
chmod +x datailama-{{os}}-{{arch}}
11+
# For Windows
12+
# No action needed, use the .exe file directly
13+
```
14+
15+
## Usage
16+
Run the binary:
17+
```bash
18+
./datailama-{{os}}-{{arch}} serve
19+
```
20+
21+
For more information, see the [README.md](README.md).

0 commit comments

Comments
 (0)