Skip to content

Commit 1339e1a

Browse files
committed
Update versioning
1 parent c5dfcfd commit 1339e1a

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,21 @@ in their workflows.
66

77
## Installation
88

9-
```
10-
npm install @simplelocalize/cli@2.9.1
9+
```shell
10+
npm install @simplelocalize/cli
1111
```
1212

1313
After installing the package, it should automatically choose the right binary for
1414
your system and install it into `node_modules/.bin` directory, to make it available for your
1515
scripts in `package.json`.
1616

17-
## Usage
18-
19-
Package SimpleLocalize CLI in your project and makes it available in `package.json` scripts.
20-
21-
22-
```
17+
```json
2318
{
2419
"name": "My project",
2520
"version": "1.0.0",
2621
"private": true,
2722
"dependencies": {
28-
"@simplelocalize/cli": "^2.9.1",
23+
"@simplelocalize/cli": "^2.9.2",
2924
},
3025
"scripts": {
3126
"start": "react-scripts start",
@@ -38,15 +33,23 @@ Package SimpleLocalize CLI in your project and makes it available in `package.js
3833

3934
Learn more about [SimpleLocalize CLI commands](https://github.com/simplelocalize/simplelocalize-cli)
4035

36+
37+
## NPX Support
38+
39+
You can also use `npx` to run SimpleLocalize CLI commands without installing the package
40+
globally:
41+
42+
```shell
43+
npx @simplelocalize/cli download
44+
```
45+
4146
## Versioning explanation
4247

4348
`@simplelocalize/cli` versioning is synced with https://github.com/simplelocalize/simplelocalize-cli versioning.
4449

45-
`@simplelocalize/cli@{CLI_VERSION}-release.{NPM_VERSION}` is the versioning scheme used in this package.
46-
Where `CLI_VERSION` is the version of SimpleLocalize CLI and `NPM_VERSION` is the version of this npm package.
47-
4850
`@simplelocalize/[email protected]` will install SimpleLocalize CLI 2.9.x and this npm package version is 1.
4951
`@simplelocalize/[email protected]` will install SimpleLocalize CLI 2.9.x and this npm package version is 2.
5052

5153
By using this versioning scheme, we can release new versions of this npm package
52-
without changing the SimpleLocalize CLI version, for example, to fix bugs in this package.
54+
without changing the SimpleLocalize CLI version, for example, to fix bugs in this package,
55+
and follow semantic versioning rules.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@simplelocalize/cli",
3-
"version": "2.9.1",
3+
"version": "2.9.2",
44
"description": "SimpleLocalize CLI for NPM",
55
"main": "index.cjs",
66
"type": "module",

0 commit comments

Comments
 (0)