Skip to content

Commit 672a3c5

Browse files
authoredMay 2, 2020
Update README.md
1 parent 877dfa6 commit 672a3c5

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed
 

‎README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -112,19 +112,6 @@ curl -fsSL https://raw.githubusercontent.com/curusarn/resh/master/scripts/rawins
112112
1. Run `git clone https://github.com/curusarn/resh.git && cd resh`
113113
2. Run `scripts/rawinstall.sh`
114114

115-
## Data sanitization and analysis
116-
117-
In order to be able to develop a good history tool I will need to get some insight into real life shell and shell history usage patterns.
118-
119-
This project is also my Master thesis so I need to be a bit scientific and base my design decisions on evidence/data.
120-
121-
Running `reshctl sanitize` creates a sanitized version of recorded history.
122-
In sanitized history, all sensitive information is replaced with its SHA256 hashes.
123-
124-
If you tried sanitizing your history and you think the result is not sanitized enough then please create an issue or message me.
125-
126-
If you would consider supporting my research/thesis by sending me a sanitized version of your history then please give me some contact info using this form: https://forms.gle/227SoyJ5c2iteKt98
127-
128115
## Examples
129116

130117
### Update
@@ -141,7 +128,7 @@ RESH CLI searches your history by commands. It uses host, directories, git remot
141128

142129
All this context is not in the regular shell history. RESH CLI will only search shell history that was recorded after you install this project.
143130

144-
*Please remember that RESH CLI is a prototype.*
131+
*I use RESH CLI everyday but please remember that it is still a prototype.*
145132

146133
![resh cli](img/screen-resh-cli-v2-6.png)
147134

@@ -221,6 +208,19 @@ You can install `jq` using your favourite package manager or you can use other J
221208

222209
*Recorded metadata will be reduced to only include useful information in the future.*
223210

211+
## Data sanitization and analysis
212+
213+
In order to be able to develop a good history tool I will need to get some insight into real life shell and shell history usage patterns.
214+
215+
This project is also my Master thesis so I need to be a bit scientific and base my design decisions on evidence/data.
216+
217+
Running `reshctl sanitize` creates a sanitized version of recorded history.
218+
In sanitized history, all sensitive information is replaced with its SHA256 hashes.
219+
220+
If you tried sanitizing your history and you think the result is not sanitized enough then please create an issue or message me.
221+
222+
If you would consider supporting my research/thesis by sending me a sanitized version of your history then please give me some contact info using this form: https://forms.gle/227SoyJ5c2iteKt98
223+
224224
## Known issues
225225

226226
### Q: I use bash on macOS and resh doesn't work

0 commit comments

Comments
 (0)
Please sign in to comment.