Skip to content

Commit 0b5c439

Browse files
committed
Add license, add screenshot and usage to readme
1 parent 1802de5 commit 0b5c439

File tree

3 files changed

+39
-0
lines changed

3 files changed

+39
-0
lines changed

LICENSE.txt

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

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
Get help from [explainshell.com](https://explainshell.com), right from your shell.
44

5+
![Screenshot of explainshell](screenshot.png)
6+
7+
## Usage
8+
9+
```shell
10+
# General usage:
11+
explainshell <command>
12+
13+
# For example:
14+
explainshell tar xzf archive.tar.gz
15+
16+
# Show the help and info:
17+
explainshell --help
18+
19+
# Disable color output:
20+
explainshell --no-color <command>
21+
```
22+
523
## Development
624

725
```shell

screenshot.png

35.8 KB
Loading

0 commit comments

Comments
 (0)