engly 1.0.0 β 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +22 -21
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,12 @@ All notable changes to this project are documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.1.0] - 2026-09-26
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
- README Quick start now installs with `npm install -g engly`, now that the package is published on npm.
|
|
13
|
+
|
|
8
14
|
## [1.0.0] - 2026-09-26
|
|
9
15
|
|
|
10
16
|
First version: project foundation and `engly init` for Claude Code.
|
|
@@ -28,4 +34,5 @@ First version: project foundation and `engly init` for Claude Code.
|
|
|
28
34
|
- Version check on pull requests to `main`: `version` in `package.json` must be greater than on `main` (semver, prereleases included), and `CHANGELOG.md` must have an entry for it. All jobs report to a single `Required checks` status for branch protection.
|
|
29
35
|
- Release workflow on pushes to `main`: publishes to npm with provenance (trusted publishing, no token) and creates the `vX.Y.Z` tag and GitHub release from the CHANGELOG entry.
|
|
30
36
|
|
|
37
|
+
[1.1.0]: https://github.com/victorcastro/engly/releases/tag/v1.1.0
|
|
31
38
|
[1.0.0]: https://github.com/victorcastro/engly/releases/tag/v1.0.0
|
package/README.md
CHANGED
|
@@ -16,6 +16,11 @@ One command. Every agent. Always on. Zero cost.
|
|
|
16
16
|
|
|
17
17
|
You write prompts to an AI all day. Why not improve your English while you do it?
|
|
18
18
|
|
|
19
|
+
- **Always on.** Coaching starts with your next prompt, no command to remember.
|
|
20
|
+
- **Never in your way.** A few lines of feedback, then the task goes on as usual.
|
|
21
|
+
- **Zero cost.** No API keys, no extra model. The agent you already use does the coaching.
|
|
22
|
+
- **For any level.** From A2 to C1, in any native language.
|
|
23
|
+
|
|
19
24
|
Engly teaches the coding agent you already use (Claude Code, Codex, Cursorβ¦) to coach your English. Every prompt becomes a tiny lesson: the agent shows you how to say it in clear English, points out a couple of mistakes, and then does the task as if you had written the better prompt.
|
|
20
25
|
|
|
21
26
|
No extra app, no extra model, no extra cost. Just better English and clearer prompts.
|
|
@@ -52,20 +57,19 @@ Sure, here's the updated function...
|
|
|
52
57
|
|
|
53
58
|
**Your English is already right?** Engly stays quiet and the agent just gets to work.
|
|
54
59
|
|
|
55
|
-
## π‘ Why Engly
|
|
56
|
-
|
|
57
|
-
- **Always on.** No command to remember. Coaching starts with your next prompt.
|
|
58
|
-
- **Never in your way.** A few lines of feedback, then the task goes on. It never asks for confirmation.
|
|
59
|
-
- **Zero cost.** No API keys and no calls to other models. The agent you already use does the coaching.
|
|
60
|
-
- **Safe for your files.** Engly only writes inside its own marked block and never touches anything else.
|
|
61
|
-
- **Made for learners.** Built with Spanish speakers in mind, and it works for any native language from A2 to C1.
|
|
62
|
-
|
|
63
60
|
## π Quick start
|
|
64
61
|
|
|
65
62
|
> [!NOTE]
|
|
66
|
-
> Engly is in early development. Today `engly init` works for **Claude Code
|
|
63
|
+
> Engly is in early development. Today `engly init` works for **Claude Code**. More agents and commands are coming soon.
|
|
64
|
+
|
|
65
|
+
Install it with one command:
|
|
67
66
|
|
|
68
|
-
|
|
67
|
+
```sh
|
|
68
|
+
npm install -g engly
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
<details>
|
|
72
|
+
<summary>Or install from a clone</summary>
|
|
69
73
|
|
|
70
74
|
```sh
|
|
71
75
|
git clone https://github.com/victorcastro/engly.git
|
|
@@ -75,17 +79,16 @@ npm run build
|
|
|
75
79
|
npm link
|
|
76
80
|
```
|
|
77
81
|
|
|
82
|
+
</details>
|
|
83
|
+
|
|
78
84
|
Then, in your project:
|
|
79
85
|
|
|
80
86
|
```sh
|
|
81
|
-
cd your-project
|
|
82
87
|
engly init
|
|
83
88
|
```
|
|
84
89
|
|
|
85
90
|
Open your agent as usual. Your next prompt will be coached. π
|
|
86
91
|
|
|
87
|
-
Once Engly is on npm, installing will be a single command: `npm install -g engly`.
|
|
88
|
-
|
|
89
92
|
## π€ Supported agents
|
|
90
93
|
|
|
91
94
|
| Agent | Where Engly adds its instructions | Status |
|
|
@@ -98,15 +101,13 @@ Once Engly is on npm, installing will be a single command: `npm install -g engly
|
|
|
98
101
|
|
|
99
102
|
## π¬ In-chat commands
|
|
100
103
|
|
|
101
|
-
While you chat with
|
|
104
|
+
While you chat with Claude Code:
|
|
102
105
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
In Codex, use `$engly-off` instead of `/engly-off`. In any agent you can also just type **"engly off"** or **"engly on"**.
|
|
106
|
+
```sh
|
|
107
|
+
$ /engly-off # Pause the coach for this session
|
|
108
|
+
$ /engly-on # Resume the coach
|
|
109
|
+
$ /engly-review # Deep review of a prompt: every mistake, why, and better alternatives
|
|
110
|
+
```
|
|
110
111
|
|
|
111
112
|
## β¨οΈ CLI commands
|
|
112
113
|
|