Skip to content

Commit 0157dd4

Browse files
authored
fix: no extra redundant files in the bundle (#13)
* fix: no extra redundant files in the bundle * docs: update README
1 parent 8558f32 commit 0157dd4

3 files changed

Lines changed: 69 additions & 1 deletion

File tree

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ GNU General Public License
22
==========================
33

44
_Version 3, 29 June 2007_
5-
Copyright (c) 2023 Medžuslovjansky (Меджусловјанскы)
5+
Copyright (c) 2024 Medžuslovjansky (Меджусловјанскы)
66

77
Everyone is permitted to copy and distribute verbatim copies of this license
88
document, but changing it is not allowed.

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Interslavic CLI Toolkit
2+
3+
[![CI/CD](https://github.com/medzuslovjansky/database-engine/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/medzuslovjansky/database-engine/actions/workflows/ci-cd.yml)
4+
[![npm version](https://badge.fury.io/js/%40interslavic%2Fcli.svg)](https://badge.fury.io/js/%40interslavic%2Fcli)
5+
[![License: GNU GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
6+
7+
The Interslavic CLI Toolkit is a command-line interface tool designed to synchronize the Interslavic language database between Google Sheets and a Git+XML repository. It provides various commands for managing synsets and performing operations on Google Spreadsheets.
8+
9+
## Installation
10+
11+
```bash
12+
npm install -g @interslavic/cli
13+
```
14+
15+
or
16+
17+
```bash
18+
yarn global add @interslavic/cli
19+
```
20+
21+
## Usage
22+
23+
```bash
24+
isv [command] [options]
25+
```
26+
27+
### Available Commands:
28+
29+
- `synsets`: Execute operations on synsets
30+
- `spreadsheets`: Execute operations on Google Spreadsheets
31+
- `users`: Edit the configuration file
32+
33+
For more detailed information on each command, use the `--help` option:
34+
35+
```bash
36+
isv --help
37+
isv synsets --help
38+
isv spreadsheets --help
39+
isv users --help
40+
```
41+
42+
## Development
43+
44+
This project uses Yarn workspaces and requires Node.js version 20.18.0 or higher.
45+
46+
To set up the development environment:
47+
48+
1. Clone the repository
49+
2. Run `yarn install`
50+
3. Build the project with `yarn build`
51+
52+
### Scripts
53+
54+
- `yarn build`: Build the project
55+
- `yarn start`: Run the CLI
56+
- `yarn lint`: Run linter on all workspaces
57+
- `yarn test`: Run tests on all workspaces
58+
59+
## Contributing
60+
61+
Please read our contributing guidelines and code of conduct before submitting pull requests or issues.
62+
63+
## License
64+
65+
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
"packages/*",
1212
"presets/*"
1313
],
14+
"files": [
15+
"dist/cli.*"
16+
],
1417
"engines": {
1518
"node": ">=20.18.0"
1619
},

0 commit comments

Comments
 (0)