Skip to content

Commit

Permalink
docs(dotfiles): 📝 Update README.md to reflect enhancements in archive…
Browse files Browse the repository at this point in the history
…s.aliases.sh

- Bumped version to v0.2.468 to match the script's latest version. - Expanded supported archive formats and updated usage examples. - Introduced new features section, highlighting defensive coding practices and portability improvements. - Ensured that all new aliases and functionalities from the script are accurately described.
  • Loading branch information
sebastienrousseau committed Feb 19, 2024
1 parent 7c01be2 commit 7ba9953
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions lib/aliases/archives/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,17 @@ The following compression formats are supported:
- zip

These aliases enable users to compress or extract files and directories
quickly by using simple commands.
quickly by using simple commands. Here are examples for each operation:

For example:
- To compress a directory to a 7z file: `compress_7z <archive_name.7z> <directory>`
- To extract from a 7z file: `extract_7z <archive_name.7z>`

- `c7z` can be used to compress a whole directory (including
subdirectories) to a 7z file.
- `e7z` can be used to extract a whole directory (including
subdirectories) from a 7z file.
Similar commands apply for all supported formats, ensuring ease of use.

Similarly, there are aliases for compressing and extracting files and
directories in all supported formats.
**New Features:**

The aliases are designed to be easy to remember and use, and they should
make the compression and extraction process much simpler for users.
- Defensive coding practices ensure aliases are only defined if the required archive programs are present, improving the script's robustness.

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 141 Warning

Expected: 80; Actual: 141
- Enhanced portability with updates to support a wider range of archive formats and systems.

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 92 Warning

Expected: 80; Actual: 92

Please note that some of the compression formats may require additional
software to be installed on your system.
Expand Down

0 comments on commit 7ba9953

Please sign in to comment.