Skip to content

Commit 12ae5f8

Browse files
authored
Merge pull request #907 from OlegChuev/main
README polishing, fixed typo in compress package docs
2 parents 546e6c0 + e98d2e1 commit 12ae5f8

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

Diff for: README.md

+2
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,13 @@ curl https://getcroc.schollz.com | bash
4040
### On macOS
4141

4242
Using [Homebrew](https://brew.sh/):
43+
4344
```bash
4445
brew install croc
4546
```
4647

4748
Using [MacPorts](https://www.macports.org/):
49+
4850
```bash
4951
sudo port selfupdate
5052
sudo port install croc

Diff for: src/cli/cli.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ func Run() (err error) {
141141
if classicInsecureMode {
142142
// classic mode not enabled
143143
fmt.Print(`Classic mode is currently ENABLED.
144-
144+
145145
Disabling this mode will prevent the shared secret from being visible
146146
on the host's process list when passed via the command line. On a
147147
multi-user system, this will help ensure that other local users cannot
@@ -166,7 +166,7 @@ Do you wish to continue to DISABLE the classic mode? (y/N) `)
166166
// enable classic mode
167167
// touch the file
168168
fmt.Print(`Classic mode is currently DISABLED.
169-
169+
170170
Please note that enabling this mode will make the shared secret visible
171171
on the host's process list when passed via the command line. On a
172172
multi-user system, this could allow other local users to access the
@@ -404,15 +404,15 @@ func send(c *cli.Context) (err error) {
404404
if (!(runtime.GOOS == "windows") && c.IsSet("code")) || os.Getenv("CROC_SECRET") != "" {
405405
crocOptions.SharedSecret = os.Getenv("CROC_SECRET")
406406
if crocOptions.SharedSecret == "" {
407-
fmt.Printf(`On UNIX systems, to send with a custom code phrase,
407+
fmt.Printf(`On UNIX systems, to send with a custom code phrase,
408408
you need to set the environmental variable CROC_SECRET:
409409
410410
CROC_SECRET=**** croc send file.txt
411411
412412
Or you can have the code phrase automatically generated:
413413
414414
croc send file.txt
415-
415+
416416
Or you can go back to the classic croc behavior by enabling classic mode:
417417
418418
croc --classic
@@ -660,15 +660,15 @@ func receive(c *cli.Context) (err error) {
660660
} else if !(runtime.GOOS == "windows") && crocOptions.SharedSecret != "" && !classicInsecureMode {
661661
crocOptions.SharedSecret = os.Getenv("CROC_SECRET")
662662
if crocOptions.SharedSecret == "" {
663-
fmt.Printf(`On UNIX systems, to receive with croc you either need
663+
fmt.Printf(`On UNIX systems, to receive with croc you either need
664664
to set a code phrase using your environmental variables:
665-
666-
CROC_SECRET=**** croc
665+
666+
CROC_SECRET=**** croc
667667
668668
Or you can specify the code phrase when you run croc without
669669
declaring the secret on the command line:
670670
671-
croc
671+
croc
672672
Enter receive code: ****
673673
674674
Or you can go back to the classic croc behavior by enabling classic mode:

Diff for: src/compress/compress.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func compress(src []byte, dest io.Writer, level int) {
4343
compressor.Close()
4444
}
4545

46-
// compress uses flate to decompress an io.Reader
46+
// decompress uses flate to decompress an io.Reader
4747
func decompress(src io.Reader, dest io.Writer) {
4848
decompressor := flate.NewReader(src)
4949
if _, err := io.Copy(dest, decompressor); err != nil {

0 commit comments

Comments
 (0)