Skip to content

Commit b53c7b9

Browse files
efoutsclaude
andcommitted
docs: streamline README for better user experience
Simplify README by removing overly technical sections and focusing on user-friendly installation and troubleshooting guidance: - Simplify introduction description - Remove debug mode instructions (too technical for end users) - Remove detailed bug reporting requirements - Remove contributing section (available in CLAUDE.md) - Remove settings file creation instructions - Keep essential troubleshooting and security information This makes the README more accessible to AWS Bedrock users who just want to quickly install and use the status line feature. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent dd4a5d9 commit b53c7b9

File tree

1 file changed

+1
-30
lines changed

1 file changed

+1
-30
lines changed

README.md

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Claude Code Context Status Line for AWS Bedrock Users
22

3-
A secure, high-performance CLI tool to restore context window visibility for AWS Bedrock users in Claude Code by displaying real-time token usage in the status line. **Specifically designed for AWS Bedrock users who have lost access to the `/context` command** in Claude Code and need to restore visibility into their context window usage.
3+
Custom Claude Code status line to restore context window visibility for AWS Bedrock users by displaying token usage. **Specifically designed for AWS Bedrock users who have lost access to the `/context` command** in Claude Code and need to restore visibility into their context window usage.
44

55
## What It Does
66

@@ -70,12 +70,6 @@ chmod +x context-status.js
7070
- **Linux**: `~/.claude/settings.json`
7171
- **Windows**: `%USERPROFILE%\.claude\settings.json`
7272

73-
**If settings file doesn't exist:** Create the directory and file:
74-
```bash
75-
mkdir -p ~/.claude
76-
echo '{"statusLine":{"type":"command","command":"npx @thisdot/claude-code-context-status-line"}}' > ~/.claude/settings.json
77-
```
78-
7973
## Troubleshooting
8074

8175
### Common Issues
@@ -104,19 +98,8 @@ echo '{"statusLine":{"type":"command","command":"npx @thisdot/claude-code-contex
10498
- Verify your conversation is generating token usage data
10599
- Check that transcript files are being created in the expected location
106100

107-
### Debug Mode
108-
Add logging by temporarily modifying the script to output debug info:
109-
```javascript
110-
console.error('[DEBUG] Input:', inputData);
111-
```
112-
113101
### Getting Help
114102
1. Check the [Issues page](https://github.com/thisdot/claude-code-context-status-line/issues) for similar problems
115-
2. When reporting bugs, include:
116-
- Node.js version (`node --version`)
117-
- Claude Code version (`claude --version`)
118-
- Operating system
119-
- Complete error message
120103

121104
## Security & Privacy
122105

@@ -186,18 +169,6 @@ console.error('[DEBUG] Input:', inputData);
186169
- Shows cumulative token count for entire conversation
187170
- Reflects the most recent conversation state
188171

189-
## Contributing
190-
191-
See our [Contributing Guidelines](CLAUDE.md) for development setup, testing requirements, and security considerations.
192-
193-
**Quick development setup:**
194-
```bash
195-
git clone https://github.com/thisdot/claude-code-context-status-line
196-
cd claude-code-context-status-line
197-
pnpm install # Note: uses pnpm, not npm
198-
pnpm test # Run tests
199-
```
200-
201172
## License
202173

203174
MIT License - see [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)