Skip to content

Commit a41296e

Browse files
committed
Cleanup documentation
1 parent c8b60c2 commit a41296e

3 files changed

Lines changed: 8 additions & 51 deletions

File tree

docs/getting-started.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,7 @@
55
### Using uv
66

77
```bash
8-
uv pip install entity-manager
9-
```
10-
11-
### Using pip
12-
13-
```bash
14-
pip install entity-manager
8+
uv tool install git+https://github.com/TomzxCode/entity-manager
159
```
1610

1711
## Configuration
@@ -32,10 +26,7 @@ NOTION_DATABASE_ID=your_database_id_here
3226
Once installed, you can use the CLI:
3327

3428
```bash
35-
# Show help
36-
entity-manager --help
37-
38-
# Show available commands
29+
# Show help/available commands
3930
entity-manager --help
4031
```
4132

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Entity Manager is a tool designed to help manage and track entities across your
1616
## Quick Start
1717

1818
```bash
19-
# Install the package
20-
uv pip install entity-manager
19+
# Install the tool
20+
uv tool install git+https://github.com/TomzxCode/entity-manager
2121

2222
# Run the CLI
2323
entity-manager --help

docs/usage.md

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -21,48 +21,14 @@ entity-manager --help
2121

2222
```bash
2323
# List entities
24-
entity-manager entities list
24+
entity-manager list
2525

2626
# Add a new entity
27-
entity-manager entities add
27+
entity-manager create
2828

2929
# Update an entity
30-
entity-manager entities update
30+
entity-manager update
3131

3232
# Delete an entity
33-
entity-manager entities delete
34-
```
35-
36-
## GitHub Integration
37-
38-
Entity Manager can integrate with GitHub to track entities across repositories:
39-
40-
```bash
41-
# Sync with GitHub
42-
entity-manager github sync
43-
```
44-
45-
## Notion Integration
46-
47-
Entity Manager can sync entities with Notion databases:
48-
49-
```bash
50-
# Sync with Notion
51-
entity-manager notion sync
52-
```
53-
54-
## Configuration File
55-
56-
You can also configure Entity Manager using a YAML configuration file (`.entity-manager.yml`):
57-
58-
```yaml
59-
github:
60-
token: ${GITHUB_TOKEN}
61-
repos:
62-
- owner/repo1
63-
- owner/repo2
64-
65-
notion:
66-
token: ${NOTION_TOKEN}
67-
database_id: ${NOTION_DATABASE_ID}
33+
entity-manager delete
6834
```

0 commit comments

Comments
 (0)