Skip to content

Commit 099dfae

Browse files
committed
Pridano README.md a LICENSE.md.
# Co: - Pridany soubory: - README.md - Zakladni pouziti cli aplikace - LICENSE.md - MIT # Proc: - Readme shrnuje jak pouzit `version` a slouzi jako napoveda. - Licence chybela.
1 parent 6186aaa commit 099dfae

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

LICENSE.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
The MIT License (MIT)
2+
=====================
3+
4+
Copyright (c) `2019` `MWarCZ`
5+
6+
> Permission is hereby granted, free of charge, to any person obtaining a copy
7+
> of this software and associated documentation files (the "Software"), to deal
8+
> in the Software without restriction, including without limitation the rights
9+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
> copies of the Software, and to permit persons to whom the Software is
11+
> furnished to do so, subject to the following conditions:
12+
>
13+
> The above copyright notice and this permission notice shall be included in
14+
> all copies or substantial portions of the Software.
15+
>
16+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22+
> THE SOFTWARE.
23+

README.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Versioner
2+
CLI nástroj pro usnadnění práce při měnění verze v konfiguračních souborech v projektech. Vhodné pro projekty, kde je verze uložena na více místech.
3+
4+
------------
5+
6+
## Použití
7+
```bash
8+
versioner <file.json ...> [-s | --set <version>] [-t | --tag <path.to.version>]
9+
versioner <file.json ...> [-n | --next <level>] [--preid <preid>] [-t | --tag <path.to.version>]
10+
versioner [--version | -v]
11+
versioner [--help | -h]
12+
```
13+
### Přepínače
14+
- **-s, --set**
15+
- Nastaveni konkrétní verze v daném souboru/souborech.
16+
- Verze musí být ve formátu `Major.Minor.Patch`
17+
- **-n, --next**
18+
- Zvýší verzi v souboru dle zadané úrovně.
19+
- Možné úrovně: *major, minor, patch*
20+
- `-n path`: *1.2.3* => *1.2.4*
21+
- `-n minor`: *1.2.3* => *1.3.0*
22+
- `-n major`: *1.2.3* => *2.0.0*
23+
- **-t, --tag**
24+
- Změní cestu, kde je hledána verze v souboru.
25+
- Pokud není použit přepínač, tak výchozí cesta je *version*.
26+
- ` `: `{ "version": "1.2.3", ... }`
27+
- Pomocí teček je možné zanořovat se hlouběji do struktury souboru.
28+
- `-t ver`: `{ "ver": "1.2.3", ... }`
29+
- `-t conf.env.version`: `{ "conf": { "env": { "version": "1.2.3", ... }, ... }, ... }`
30+
- **--preid**
31+
- Označení použité pro předběžné verze
32+
- např. `prerelease`, `prepatch`, `preminor`, `premajor`
33+
- **-v, --version**
34+
- Vypíše verzi používaného nástroje ***versioner***.
35+
- **-h, --help**
36+
- Vypíše nápovědu k nástroji ***versioner***.
37+
38+
---------------

0 commit comments

Comments
 (0)