Skip to content

Commit 22cca55

Browse files
committed
Update package.json to use Codebuff name. Also add terminal commands disclaimer
1 parent b9f04a0 commit 22cca55

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

npm-app/README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
# The AI coder for serious engineers
22

3-
Manicode helps you generate better code from your terminal.
3+
Codebuff helps you generate better code from your terminal.
44

5-
1. Run `manicode` from your project directory
5+
1. Run `codebuff` from your project directory
66
2. Tell it what to do
77
3. It will read and write to files to produce the code you want
88

9+
Note: Codebuff can run commands in your terminal as it deems necessary to fulfill your request.
10+
911
## Installation
1012

11-
To install Manicode, run:
13+
To install Codebuff, run:
1214

1315
```bash
14-
npm install -g manicode
16+
npm install -g codebuff
1517
```
1618

1719
## Usage
1820

19-
After installation, you can start Manicode by running:
21+
After installation, you can start Codebuff by running:
2022

2123
```bash
22-
manicode [project-directory]
24+
codebuff [project-directory]
2325
```
2426

25-
If no project directory is specified, Manicode will use the current directory.
27+
If no project directory is specified, Codebuff will use the current directory.
2628

27-
After running `manicode`, simply chat with it to say what coding task you want done.
29+
After running `codebuff`, simply chat with it to say what coding task you want done.
2830

2931
## Features
3032

@@ -33,25 +35,25 @@ After running `manicode`, simply chat with it to say what coding task you want d
3335
- Runs commands in your terminal
3436
- Scrapes the web to gather information for tasks
3537

36-
Ask Manicode to implement small features, write unit tests, write scripts, or give advice.
38+
Ask Codebuff to implement small features, write unit tests, write scripts, or give advice.
3739

3840
## Knowledge Files
3941

4042
To unlock the full benefits of modern LLMs, we recommend storing knowledge alongside your code. Add a `knowledge.md` file anywhere in your project to provide helpful context, guidance, and tips for the LLM as it performs tasks for you.
4143

42-
Manicode can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
44+
Codebuff can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
4345

4446
Some have said every change should be paired with a unit test. In 2024, every change should come with a knowledge update!
4547

4648
## Tips
4749

4850
1. Create a `knowledge.md` file and collect specific points of advice. The assistant will use this knowledge to improve its responses.
4951
2. Type `undo` or `redo` to revert or reapply file changes from the conversation.
50-
3. Press `Esc` or `Ctrl+C` while Manicode is generating a response to stop it.
52+
3. Press `Esc` or `Ctrl+C` while Codebuff is generating a response to stop it.
5153

5254
## Troubleshooting
5355

54-
If you are getting permission errors when installing globally with '-g', or when running `manicode`, try [installing node with a version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
56+
If you are getting permission errors when installing globally with '-g', or when running `codebuff`, try [installing node with a version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
5557

5658
#### For OSX or Unix, use [nvm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Run:
5759

@@ -67,4 +69,4 @@ Make sure to uninstall your existing node program. Then get this executable:
6769

6870
## Feedback
6971

70-
We value your input! Please email your feedback to `james@manicode.ai`. Thank you for using Manicode!
72+
We value your input! Please email your feedback to `founders@codebase.com`. Thank you for using Codebuff!

0 commit comments

Comments
 (0)