Skip to content

Commit 50c70ac

Browse files
committed
better readmes.
1 parent 3cce751 commit 50c70ac

File tree

2 files changed

+27
-7
lines changed

2 files changed

+27
-7
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# MyCoder
22

3-
An open-source mono-repository containing the MyCoder agent and cli.
4-
5-
!NOTE: To get started with the mycoder agent, [please see the CLI package](packages/cli)
6-
7-
For detailed installation instructions for macOS and Linux, [see our installation guide](docs/installation.md)
3+
Command-line interface for AI-powered coding tasks.
84

95
## Features
106

11-
- 🤖 **AI-Powered**: Leverages Anthropic's Claude and OpenAI models for intelligent decision making
7+
- 🤖 **AI-Powered**: Leverages Anthropic's Claude, OpenAI models, xAI/Grok, Mistral AI, and Ollama for intelligent coding assistance
128
- 🛠️ **Extensible Tool System**: Modular architecture with various tool categories
139
- 🔄 **Parallel Execution**: Ability to spawn sub-agents for concurrent task processing
1410
- 📝 **Self-Modification**: Can modify code, it was built and tested by writing itself
@@ -18,6 +14,30 @@ For detailed installation instructions for macOS and Linux, [see our installatio
1814

1915
Please join the MyCoder.ai discord for support: https://discord.gg/5K6TYrHGHt
2016

17+
## Installation
18+
19+
```bash
20+
npm install -g mycoder
21+
```
22+
23+
For detailed installation instructions for macOS and Linux, including how to set up Node.js using NVM, [see our Getting Started guide](https://docs.mycoder.ai/docs/getting-started/).
24+
25+
## Usage
26+
27+
```bash
28+
# Interactive mode
29+
mycoder -i
30+
31+
# Run with a prompt
32+
mycoder "Implement a React component that displays a list of items"
33+
34+
# Run with a prompt from a file
35+
mycoder -f prompt.txt
36+
37+
# Enable GitHub mode
38+
mycoder config set githubMode true
39+
```
40+
2141
## Packages
2242

2343
- [mycoder](packages/cli) - Command-line interface for MyCoder

packages/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Command-line interface for AI-powered coding tasks.
1818
npm install -g mycoder
1919
```
2020

21-
For detailed installation instructions for macOS and Linux, including how to set up Node.js using NVM, [see our installation guide](../../docs/installation.md).
21+
For detailed installation instructions for macOS and Linux, including how to set up Node.js using NVM, [see our Getting Started guide](https://docs.mycoder.ai/docs/getting-started/).
2222

2323
## Usage
2424

0 commit comments

Comments
 (0)