diff --git a/LICENSE b/LICENSE index 0c145e6..5b2adcc 100644 --- a/LICENSE +++ b/LICENSE @@ -2,7 +2,7 @@ GNU General Public License ========================== _Version 3, 29 June 2007_ -Copyright (c) 2023 Medžuslovjansky (Меджусловјанскы) +Copyright (c) 2024 Medžuslovjansky (Меджусловјанскы) Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bbb4a86 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# Interslavic CLI Toolkit + +[![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) +[![npm version](https://badge.fury.io/js/%40interslavic%2Fcli.svg)](https://badge.fury.io/js/%40interslavic%2Fcli) +[![License: GNU GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) + +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. + +## Installation + +```bash +npm install -g @interslavic/cli +``` + +or + +```bash +yarn global add @interslavic/cli +``` + +## Usage + +```bash +isv [command] [options] +``` + +### Available Commands: + +- `synsets`: Execute operations on synsets +- `spreadsheets`: Execute operations on Google Spreadsheets +- `users`: Edit the configuration file + +For more detailed information on each command, use the `--help` option: + +```bash +isv --help +isv synsets --help +isv spreadsheets --help +isv users --help +``` + +## Development + +This project uses Yarn workspaces and requires Node.js version 20.18.0 or higher. + +To set up the development environment: + +1. Clone the repository +2. Run `yarn install` +3. Build the project with `yarn build` + +### Scripts + +- `yarn build`: Build the project +- `yarn start`: Run the CLI +- `yarn lint`: Run linter on all workspaces +- `yarn test`: Run tests on all workspaces + +## Contributing + +Please read our contributing guidelines and code of conduct before submitting pull requests or issues. + +## License + +This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details. diff --git a/package.json b/package.json index 91ae588..7a85b99 100644 --- a/package.json +++ b/package.json @@ -11,6 +11,9 @@ "packages/*", "presets/*" ], + "files": [ + "dist/cli.*" + ], "engines": { "node": ">=20.18.0" },