summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 10 insertions, 8 deletions
diff --git a/README.md b/README.md
index b4f7efe..bdd97e3 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@ goals were set:
21 21
22## Requirements 22## Requirements
23 23
24Apart from Python >= 3.8, the only requirement is 24Apart from Python >= 3.10, the only requirement is
25[cryptography](https://pypi.org/project/cryptography/) 25[cryptography](https://pypi.org/project/cryptography/)
26 26
27 27
@@ -183,7 +183,7 @@ Most users (including me) will simply use the command line interface (CLI).
183 183
184The *etoolkit* CLI loads the configuration located by default in 184The *etoolkit* CLI loads the configuration located by default in
185*~/.etoolkit.json*. That file is based on 185*~/.etoolkit.json*. That file is based on
186[etoolkit_sample.json](https://github.com/blackm0re/etoolkit/blob/master/etoolkit_sample.json). 186[etoolkit_sample.json](https://codeberg.org/sgs/etoolkit/src/branch/master/etoolkit_sample.json).
187 187
188The *"instances"* part of the configuration defines unique instances, each of 188The *"instances"* part of the configuration defines unique instances, each of
189which represents its own environment with its own defined env. variables. 189which represents its own environment with its own defined env. variables.
@@ -262,6 +262,8 @@ When all values are fetched from a given instance (and its parents) and then
262decrypted, they are further processed by replacing macros with their 262decrypted, they are further processed by replacing macros with their
263corresponding values. Currently the following macros are supported: 263corresponding values. Currently the following macros are supported:
264 264
265- **%e** - the current value of the env. var. corresponding to the same key
266
265- **%h** - the home directory of the user running *etoolkit* (~/) 267- **%h** - the home directory of the user running *etoolkit* (~/)
266 268
267- **%i** - the name of the instance that is about to be loaded 269- **%i** - the name of the instance that is about to be loaded
@@ -395,18 +397,18 @@ bottom of your bash startup file:
395 ``` 397 ```
396 398
397A complete bash completion script for *etoolkit* can be found here: 399A complete bash completion script for *etoolkit* can be found here:
398[https://github.com/blackm0re/etoolkit/blob/master/completion/etoolkit.bash](https://github.com/blackm0re/etoolkit/blob/master/completion/etoolkit.bash) 400[https://codeberg.org/sgs/etoolkit/src/branch/master/completion/etoolkit.bash](https://codeberg.org/sgs/etoolkit/src/branch/master/completion/etoolkit.bash)
399 401
400 402
401## Changelog 403## Changelog
402 404
403A complete changelog can be found at: 405A complete changelog can be found at:
404[https://github.com/blackm0re/etoolkit/blob/master/CHANGELOG.md](https://github.com/blackm0re/etoolkit/blob/master/CHANGELOG.md) 406[https://codeberg.org/sgs/etoolkit/src/branch/master/CHANGELOG.md](https://codeberg.org/sgs/etoolkit/src/branch/master/CHANGELOG.md)
405 407
406 408
407## Support and contributing 409## Support and contributing
408 410
409*etoolkit* is hosted on GitHub: https://github.com/blackm0re/etoolkit 411*etoolkit* is hosted on Codeberg: https://codeberg.org/sgs/etoolkit
410 412
411 413
412## Author 414## Author
@@ -414,11 +416,11 @@ A complete changelog can be found at:
414Simeon Simeonov - sgs @ LiberaChat 416Simeon Simeonov - sgs @ LiberaChat
415 417
416 418
417## [License](https://github.com/blackm0re/etoolkit/blob/master/LICENSE) 419## [License](https://codeberg.org/sgs/etoolkit/src/branch/master/LICENSE)
418 420
419Copyright (C) 2021-2024 Simeon Simeonov 421Copyright (C) 2021-2026 Simeon Simeonov
420All rights reserved. 422All rights reserved.
421 423
422[Licensed](https://github.com/blackm0re/etoolkit/blob/master/LICENSE) under the 424[Licensed](https://codeberg.org/sgs/etoolkit/src/branch/master/LICENSE) under the
423GNU General Public License v3.0 or later. 425GNU General Public License v3.0 or later.
424SPDX-License-Identifier: GPL-3.0-or-later 426SPDX-License-Identifier: GPL-3.0-or-later