copy cli/release-staging into cli/release

Author: charleslien

cli/release/README.md

@@ -0,0 +1,71 @@
+# 🚀 Codecane - The most powerful coding agent (STAGING)
+
+**⚠️ This is a staging/beta release for testing purposes.**
+
+Codecane is a CLI tool that writes code for you.
+
+1. Run `codecane` from your project directory
+2. Tell it what to do
+3. It will read and write to files and run commands to produce the code you want
+
+Note: Codecane will run commands in your terminal as it deems necessary to fulfill your request.
+
+## Installation
+
+To install Codecane (staging), run:
+
+```bash
+npm install -g codecane@beta
+```
+
+(Use `sudo` if you get a permission error.)
+
+## Usage
+
+After installation, you can start Codecane by running:
+
+```bash
+codecane [project-directory]
+```
+
+If no project directory is specified, Codecane will use the current directory.
+
+Once running, simply chat with Codecane to say what coding task you want done.
+
+## Features
+
+- Understands your whole codebase
+- Creates and edits multiple files based on your request
+- Can run your tests or type checker or linter; can install packages
+- It's powerful: ask Codecane to keep working until it reaches a condition and it will.
+
+Our users regularly use Codecane to implement new features, write unit tests, refactor code, write scripts, or give advice.
+
+## Knowledge Files
+
+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.
+
+Codecane can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
+
+Some have said every change should be paired with a unit test. In 2024, every change should come with a knowledge update!
+
+## Tips
+
+1. Type '/help' or just '/' to see available commands.
+2. Create a `knowledge.md` file and collect specific points of advice. The assistant will use this knowledge to improve its responses.
+3. Type `undo` or `redo` to revert or reapply file changes from the conversation.
+4. Press `Esc` or `Ctrl+C` while Codecane is generating a response to stop it.
+
+## Troubleshooting
+
+If you are getting permission errors during installation, try using sudo:
+
+```
+sudo npm install -g codecane@beta
+```
+
+If you still have errors, it's a good idea to [reinstall Node](https://nodejs.org/en/download).
+
+## Feedback
+
+We value your input! Please email your feedback to `founders@codebuff.com`. Thank you for using Codecane!