Skip to content

Commit 6a2cf72

Browse files
authored
docs(readme): simplify installation instructions (#98)
* docs(readme): simplify installation instructions Remove the intermediate "Install the plugin" step that referenced the deprecated code-please plugin installation commands. Rename the language-specific LSP plugins section to Step 2 for clarity. * ci: switch from self-hosted runners to ubuntu-latest * ci: replace runs-on/cache with actions/cache
1 parent 3613f38 commit 6a2cf72

3 files changed

Lines changed: 8 additions & 22 deletions

File tree

.github/workflows/ci.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ env:
1616

1717
jobs:
1818
lint:
19-
runs-on: [self-hosted, linux, x64, ubuntu-2404, aws]
19+
runs-on: ubuntu-latest
2020
steps:
2121
- uses: actions/checkout@v4
2222
with:
@@ -26,7 +26,7 @@ jobs:
2626
with:
2727
bun-version: latest
2828

29-
- uses: runs-on/cache@v4
29+
- uses: actions/cache@v4
3030
with:
3131
path: ~/.bun/install/cache
3232
key: bun-cache-${{ hashFiles('**/bun.lock') }}
@@ -44,15 +44,15 @@ jobs:
4444
run: bun run lint
4545

4646
typecheck:
47-
runs-on: [self-hosted, linux, x64, ubuntu-2404, aws]
47+
runs-on: ubuntu-latest
4848
steps:
4949
- uses: actions/checkout@v4
5050

5151
- uses: oven-sh/setup-bun@v2
5252
with:
5353
bun-version: latest
5454

55-
- uses: runs-on/cache@v4
55+
- uses: actions/cache@v4
5656
with:
5757
path: ~/.bun/install/cache
5858
key: bun-cache-${{ hashFiles('**/bun.lock') }}
@@ -65,15 +65,15 @@ jobs:
6565
run: bun run typecheck
6666

6767
test:
68-
runs-on: [self-hosted, linux, x64, ubuntu-2404, aws]
68+
runs-on: ubuntu-latest
6969
steps:
7070
- uses: actions/checkout@v4
7171

7272
- uses: oven-sh/setup-bun@v2
7373
with:
7474
bun-version: latest
7575

76-
- uses: runs-on/cache@v4
76+
- uses: actions/cache@v4
7777
with:
7878
path: ~/.bun/install/cache
7979
key: bun-cache-${{ hashFiles('**/bun.lock') }}

.github/workflows/release-please.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ env:
2727
jobs:
2828
release-please:
2929
if: ${{ !inputs.publish_only }}
30-
runs-on: [self-hosted, linux, x64, ubuntu-2404, aws]
30+
runs-on: ubuntu-latest
3131
outputs:
3232
releases_created: ${{ steps.release.outputs.releases_created }}
3333
release_created: ${{ steps.release.outputs.release_created }}

README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,7 @@ Auto-formatting and LSP diagnostics plugin for Claude Code. Get real-time type c
1919
/plugin marketplace add pleaseai/code-intelligence
2020
```
2121

22-
### Step 2: Install the plugin
23-
24-
```bash
25-
# Install core plugin (auto-formatting hooks + LSP diagnostics)
26-
/plugin install code-please@code-intelligence
27-
28-
# Install to project scope (shared with team via .claude/settings.json)
29-
/plugin install code-please@code-intelligence --scope project
30-
```
31-
32-
This installs the `code-please` plugin which provides:
33-
- PostToolUse hooks for auto-formatting on Write/Edit
34-
- LSP diagnostics fed back as context to Claude
35-
36-
### Install language-specific LSP plugins
22+
### Step 2: Install language-specific LSP plugins
3723

3824
Install only the language servers you need:
3925

0 commit comments

Comments
 (0)