Skip to content

Commit 0ef437e

Browse files
committed
chore: update README to clarify installation steps and update Node.js requirement
- Revised installation instructions for better clarity, emphasizing the need to install the Sourcegraph Cody extension first. - Updated Node.js requirement from 18.x to 20.x for compatibility.
1 parent 186a020 commit 0ef437e

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

README.md

+5-23
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,13 @@ Enhances [Cody AI](https://sourcegraph.com/cody) with additional files control a
1212
[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/CodyPlusPlus)](https://twitter.com/CodyPlusPlus)
1313
![CI Tests](https://github.com/mnismt/CodyPlusPlus/actions/workflows/test.yml/badge.svg)
1414

15-
## Requirements
16-
17-
- You must have the [Cody](https://marketplace.visualstudio.com/items?itemName=sourcegraph.cody-ai) extension installed in VS Code.
18-
1915
## Installation
2016

21-
You can install the Cody++ extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=mnismt.cody-plus-plus)
17+
1. Install the [Sourcegraph Cody](https://marketplace.visualstudio.com/items?itemName=sourcegraph.cody-ai) extension in VS Code (if not already installed).
18+
19+
2. Install the Cody++ extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=mnismt.cody-plus-plus)
2220

23-
You can also install the extension from the command line:
21+
3. You can also install the extension from the command line:
2422

2523
```sh
2624
code --install-extension mnismt.cody-plus-plus
@@ -116,7 +114,7 @@ To configure this setting in two ways:
116114

117115
### Requirements
118116

119-
- Node.js 18.x
117+
- Node.js 20.x
120118
- pnpm 9.11.0 (specified as the package manager)
121119

122120
### Testing
@@ -127,26 +125,10 @@ The extension comes with a comprehensive test suite. To run tests locally:
127125
# Install dependencies
128126
pnpm install
129127

130-
# Run linting checks
131-
pnpm run lint
132-
133-
# Compile the extension
134-
pnpm run compile
135-
136128
# Run tests
137129
pnpm test
138130
```
139131

140-
### Continuous Integration
141-
142-
The project uses GitHub Actions for automated testing and building:
143-
144-
- Tests run on push to main branch and pull requests
145-
- Tests run on multiple platforms (Windows, macOS, Linux)
146-
- Tests run against multiple VS Code versions (stable and insiders)
147-
148-
For details about the CI setup, see [docs/ci-setup.md](docs/ci-setup.md).
149-
150132
## Telemetry
151133

152134
Cody++ collects anonymous usage information to help improve the extension. We are committed to protecting your privacy:

0 commit comments

Comments
 (0)