Skip to content

Commit e286bf2

Browse files
committed
Updating README.md
1 parent 7f4cc06 commit e286bf2

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,15 @@ sttr yaml-json file.yaml > file-output.json
3333

3434
![sttr demo](./media/demo.gif)
3535

36-
3736
# :battery: Installation
3837

3938
#### Quick install
4039

41-
You can run the below `curl` to install it somewhere in your PATH for easy use.
42-
Ideally it will be installed at `./bin` folder
40+
You can run the below `curl` to install it somewhere in your PATH for easy use. Ideally it will be installed at `./bin`
41+
folder
4342

4443
```go
45-
curl -sfL https://raw.githubusercontent.com/abhimanyu003/sttr/main/install.sh | sh
44+
curl -sfL https: //raw.githubusercontent.com/abhimanyu003/sttr/main/install.sh | sh
4645
```
4746

4847
#### Homebrew
@@ -54,23 +53,24 @@ brew tap abhimanyu003/sttr
5453
brew install sttr
5554
```
5655

57-
#### Go
56+
#### Go
5857

5958
```go
6059
go install github.com/abhimanyu003/sttr@latest
6160
```
6261

6362
#### Manually
6463

65-
Download the pre-compiled binaries from the [Release!](https://github.com/abhimanyu003/sttr/releases) page and copy them to the desired location.
64+
Download the pre-compiled binaries from the [Release!](https://github.com/abhimanyu003/sttr/releases) page and copy them
65+
to the desired location.
6666

6767
# :books: Guide
6868

6969
* After installation simply run `sttr` command.
7070

7171
```go
7272
// For interactive menu
73-
sttr
73+
sttr
7474
// Provide your input
7575
// Press two enter to open operation menu
7676
// Press `/` to filter various operations.
@@ -106,7 +106,7 @@ sttr yaml-json file.yaml > file-output.json
106106
* Taking input from other command.
107107

108108
```go
109-
curl https://jsonplaceholder.typicode.com/users | sttr json-yaml
109+
curl https: //jsonplaceholder.typicode.com/users | sttr json-yaml
110110
```
111111

112112
* Chaining the different processor.
@@ -117,10 +117,8 @@ sttr md5 hello | sttr base64-encode
117117
echo "Hello World" | sttr base64-encode | sttr md5
118118
```
119119

120-
121120
# :boom: Supported Operations
122121

123-
124122
#### Encode/Decode
125123

126124
- [x] **base32-decode** - Decode your base32 text
@@ -155,7 +153,6 @@ echo "Hello World" | sttr base64-encode | sttr md5
155153
- [x] **title** - Transform your text to Title Case
156154
- [x] **upper** - Transform your text to UPPER CASE
157155

158-
159156
#### Count
160157

161158
- [x] **count-chars** - Find the length of your text (including spaces)
@@ -167,11 +164,14 @@ echo "Hello World" | sttr base64-encode | sttr md5
167164

168165
- [x] **hex-rgb** - Convert a #hex-color code to RGB
169166
- [x] **hex-encode** - Encode your text Hex
167+
- [x] **hex-decode** - Convert Hexadecimal to String
170168

171169
#### JSON
172170

173171
- [x] **json** - Format your text as JSON
174172
- [x] **json-yaml** - Convert JSON to YAML text
173+
- [x] **json-msgpack** - Convert JSON to MSGPACK
174+
- [x] **msgpack-json** - Convert MSGPACK to JSON
175175

176176
#### YAML
177177

@@ -182,6 +182,7 @@ echo "Hello World" | sttr base64-encode | sttr md5
182182
- [x] **markdown-html** - Convert Markdown to HTML
183183

184184
#### Other
185+
185186
- [x] **completion** - generate the autocompletion script for the specified shell
186187
- [x] **interactive** - Use sttr in interactive mode
187188
- [x] **version** - Print the version of sttr
@@ -190,9 +191,8 @@ echo "Hello World" | sttr base64-encode | sttr md5
190191

191192
# Contribution
192193

193-
This project welcomes your PR and issues.
194-
For example, refactoring, adding features, correcting English, etc.
195-
If you need any help, you can contact me on [Twitter](https://twitter.com/abhimanyu003).
194+
This project welcomes your PR and issues. For example, refactoring, adding features, correcting English, etc. If you
195+
need any help, you can contact me on [Twitter](https://twitter.com/abhimanyu003).
196196

197197
Thanks to all the people who already contributed!
198198

0 commit comments

Comments
 (0)