Skip to content

Commit f633218

Browse files
committed
docs: update README with npx installation and usage instructions
- Add npx installation option as the primary method - Document CLI tool features and automatic browser opening - Include download functionality in features list - Reorganize installation and usage sections for clarity
1 parent 1b35809 commit f633218

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ A modern web application for researching New World: Aeternum game content using
1818

1919
## Installation
2020

21+
### Option 1: Install globally via npx (Recommended)
22+
```bash
23+
npx aeternum-research-tool
24+
```
25+
This will automatically download, build, and run the Aeternum Research Tool with a local server.
26+
27+
### Option 2: Install from source
2128
1. Clone the repository:
2229
```bash
2330
git clone https://github.com/involvex/new-world-expansion-research.git
@@ -39,6 +46,17 @@ A modern web application for researching New World: Aeternum game content using
3946
4047
## Usage
4148
49+
### Using npx (Simplest)
50+
```bash
51+
npx aeternum-research-tool
52+
```
53+
The tool will automatically:
54+
- Build the application (if needed)
55+
- Start a local server on `http://localhost:3000`
56+
- Open your default browser
57+
- Display the Aeternum Research Tool interface
58+
59+
### Using from source
4260
1. Start the development server:
4361
```bash
4462
npm run dev
@@ -50,6 +68,12 @@ A modern web application for researching New World: Aeternum game content using
5068

5169
4. View the AI-generated research results with sources
5270

71+
### Features
72+
- **AI-Powered Research**: Ask questions about New World Aeternum in natural language
73+
- **Download Results**: Save research findings as markdown files
74+
- **Source Citations**: View and access original sources
75+
- **Search History**: Keep track of previous research queries
76+
5377
## Available Scripts
5478

5579
- `npm run dev` - Start development server

0 commit comments

Comments
 (0)