Skip to content

Commit 62ccaf9

Browse files
committed
docs: improve formatting and readability of README.md
1 parent 6a87007 commit 62ccaf9

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ Transform scattered project folders into a unified workspace for **AI coding ass
3636
Modern **AI coding assistants** and **LLM agents** work best when they have clear, organized access to your project files. Instead of juggling multiple directories or losing context between different parts of your codebase, **Agent Context** creates a focused workspace with symlinked folders that maintain your original file structure while providing a unified view.
3737

3838
Perfect for:
39+
3940
- 🤖 **AI pair programming** sessions
40-
- 🔄 **Multi-repository workflows**
41+
- 🔄 **Multi-repository workflows**
4142
- 📁 **Monorepo navigation**
4243
- 🎯 **Focused development** sessions
4344
- 🧠 **Context switching** between projects
@@ -87,23 +88,25 @@ You'll be guided through:
8788
3. **Workspace Creation**: Automatic symlinking into your chosen workspace directory
8889

8990
#### Auto Mode
91+
9092
Creates a timestamped workspace under `~/coder-work/session-YYYYMMDD-HHMM` - perfect for quick AI coding sessions.
9193

92-
#### Manual Mode
94+
#### Manual Mode
95+
9396
Lets you choose a custom target directory for more permanent workspace setups.
9497

9598
### Keyboard Controls
9699

97100
- **↑/↓**: Navigate through folders
98-
- **←/→**: Collapse/expand directories
101+
- **←/→**: Collapse/expand directories
99102
- **Space/Enter**: Select/deselect folders
100103
- **Esc/q**: Exit the application
101104

102105
## Use Cases
103106

104107
- **🤖 AI Coding Sessions**: Create focused workspaces for:
105108
- **Claude Code** - AI pair programming with Anthropic's assistant
106-
- **Cursor** - AI-first code editor with inline completions
109+
- **Cursor** - AI-first code editor with inline completions
107110
- **Windsurf** - Agentic AI coding with Cascade interface
108111
- **GitHub Copilot** - Microsoft's AI pair programmer
109112
- **Qwen Coder** - Alibaba's open-source coding model
@@ -119,6 +122,7 @@ Lets you choose a custom target directory for more permanent workspace setups.
119122
## Workflow Examples
120123

121124
### AI Pair Programming Session with Claude Code
125+
122126
```bash
123127
# Quick setup for Claude Code session
124128
npx agent-context
@@ -127,6 +131,7 @@ npx agent-context
127131
```
128132

129133
### Cursor AI-First Development
134+
130135
```bash
131136
# Create organized workspace for Cursor
132137
agent-context
@@ -136,6 +141,7 @@ agent-context
136141
```
137142

138143
### Windsurf Agentic Coding
144+
139145
```bash
140146
# Prepare workspace for Windsurf's Cascade AI
141147
npx agent-context
@@ -144,15 +150,17 @@ npx agent-context
144150
```
145151

146152
### Multi-Repository Feature Work with GitHub Copilot
153+
147154
```bash
148155
# Create custom workspace for cross-repo feature
149156
agent-context
150-
# Choose manual mode, select ~/workspaces/user-auth-feature
157+
# Choose manual mode, select ~/workspaces/user-auth-feature
151158
# Select folders from multiple repositories
152159
# Enhanced Copilot suggestions with organized context
153160
```
154161

155162
### Terminal AI Pairing with Aider
163+
156164
```bash
157165
# Create workspace for terminal-based AI coding
158166
agent-context
@@ -178,7 +186,7 @@ This project is licensed under the [MIT License](LICENSE).
178186
If you find Agent Context helpful:
179187

180188
-**Star this repository** on [GitHub](https://github.com/nt9142/agent-context)
181-
- 🗣 **Share with colleagues** working with AI coding tools
189+
- 🗣 **Share with colleagues** working with AI coding tools
182190
- 💬 **Provide feedback** and feature suggestions
183191
- 🤝 **Contribute** to make it better for everyone
184192

0 commit comments

Comments
 (0)