Skip to content

Commit 2a0029a

Browse files
committed
Update readme file
1 parent e66d85b commit 2a0029a

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# NOTE: This is Work in Progress and not yet stable enough for external use.
1+
# NOTE: This is Work in Progress and not yet stable enough for external use!!!
22

33

44
# Vibe-Coder
@@ -29,6 +29,53 @@ flowchart LR
2929
- 🔧 **VS Code Integration**: Seamless development experience within VS Code.
3030
-**Real-time Updates**: Automatic Memory Bank updates triggered by significant events.
3131

32+
## Installation
33+
34+
Adding RooFlow to your project is simple:
35+
36+
```bash
37+
npm install --save-dev ez-vibecoder
38+
```
39+
40+
Or with yarn:
41+
42+
```bash
43+
yarn add --dev ez-vibecoder
44+
```
45+
46+
That's it! This installer will:
47+
48+
1. Download all the necessary configuration files for RooCode, Cline, Cursor, and Windsurf from the official repositories
49+
2. Set up the proper directory structure in your project
50+
3. Fix duplicate `capabilities` YAML sections in configuration files
51+
4. Validate the YAML structure of system prompt files
52+
5. Configure everything to work with VS Code's Roo Code extension
53+
54+
## Requirements
55+
56+
- VS Code with the Roo Code extension installed
57+
- Node.js
58+
59+
## Manual Installation
60+
61+
If the automatic installation doesn't run (which may happen if npm scripts are disabled in your environment). Please note that if destination files already exist, they wont be overwritten. If you intend to get the latest, please manually delete the files before installation. If your folder doesnt already contain node_modules, it will copy to the root folder of your computer:
62+
63+
```bash
64+
npm i ez-vibecoder
65+
66+
node node_modules/ez-vibecoder/installer.js
67+
```
68+
69+
## After Installation
70+
71+
Start enjoying RooFlow immediately:
72+
73+
1. Open your project in VS Code / Cursor / or WindSurf
74+
2. Start a new RooCode/Cline chat and select any of the five integrated modes
75+
3. Experience the benefits of persistent context and optimized workflows!
76+
77+
For full usage instructions, refer to the [original RooFlow documentation](https://github.com/GreatScottyMac/RooFlow).
78+
3279
# Inspired by and References
3380

3481
## RooCode Memory Bank
@@ -58,3 +105,7 @@ Reference: https://windsurf.run/
58105
## RooFlow Installer
59106
Inspired by: https://github.com/amir-arad/rooflow
60107

108+
109+
## License
110+
111+
[Apache 2.0](LICENSE)

0 commit comments

Comments
 (0)