Skip to content

Commit 30804ae

Browse files
committed
docs: refine documentation
Add some useful stuff, like usage section
1 parent 1edefd8 commit 30804ae

File tree

2 files changed

+41
-5
lines changed

2 files changed

+41
-5
lines changed

Diff for: cmd/commands/remove-everything/remove-everything.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import (
1818
// Command config
1919
var Command = &cobra.Command{
2020
Use: "remove-everything",
21-
Short: "removes everything related to the eclectica",
21+
Short: "removes everything related to eclectica",
2222
Run: run,
2323
}
2424

Diff for: readme.md

+40-4
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,48 @@
1616
</a>
1717
</p>
1818
<br/><br/>
19-
Eclectica unifies management of any language under one cohesive and minimalistic interface.
2019

21-
Like [pyenv](https://github.com/pyenv/pyenv) for Python,
22-
[rbenv](https://github.com/rbenv/rbenv) for Ruby, [nvm](https://github.com/creationix/nvm) Node.js and etc. Managing multiple languages and doing it in a little more enjoyable fashion
20+
Eclectica unifies management of any language under one cohesive and minimalistic interface.Like [pyenv](https://github.com/pyenv/pyenv) for Python,
21+
[rbenv](https://github.com/rbenv/rbenv) for Ruby, [nvm](https://github.com/creationix/nvm) Node.js and etc.
2322

24-
# Install
23+
But instead of having all of those you have only one binary - `ec`.
24+
25+
## Usage
26+
27+
After you [install](#install) eclectica, `ec` program will be available in your terminal, I used to have a nice site with fancy animation explaning how to used it, but help output will do too -
28+
29+
```
30+
$ ec --help
31+
Usage:
32+
ec [command] [flags] [<language>@<version>]
33+
34+
Examples:
35+
Install specifc version
36+
$ ec node@6.4.0
37+
38+
Choose local version with interactive list
39+
$ ec go
40+
41+
Choose remote version with interactive list
42+
$ ec -r rust
43+
44+
Available Commands:
45+
completion generate the autocompletion script for the specified shell
46+
install same as "ec [<language>@<version>]"
47+
ls list installed language versions
48+
remove-everything removes everything related to the eclectica
49+
rm remove language version
50+
version print version of Eclectica
51+
52+
Flags:
53+
-h, --help help for ec
54+
55+
Use "ec [command] --help" for more information about a command
56+
```
57+
58+
## Install
59+
60+
You can install eclectica through many package managers, since eclectica is language manager it should be installed through any package manager :-)
2561

2662
- [go get](#go-get)
2763
- [npm](#npm)

0 commit comments

Comments
 (0)