Skip to content

Commit

Permalink
docs: refine documentation
Browse files Browse the repository at this point in the history
Add some useful stuff, like usage section
  • Loading branch information
markelog committed Jan 21, 2025
1 parent 1edefd8 commit 622adb0
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 6 deletions.
2 changes: 1 addition & 1 deletion cmd/commands/remove-everything/remove-everything.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
// Command config
var Command = &cobra.Command{
Use: "remove-everything",
Short: "removes everything related to the eclectica",
Short: "removes everything related to eclectica",
Run: run,
}

Expand Down
2 changes: 1 addition & 1 deletion cmd/commands/version/verison.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
// Command config
var Command = &cobra.Command{
Use: "version",
Short: "print version of Eclectica",
Short: "print version of eclectica",
Run: run,
}

Expand Down
44 changes: 40 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,48 @@
</a>
</p>
<br/><br/>
Eclectica unifies management of any language under one cohesive and minimalistic interface.

Like [pyenv](https://github.com/pyenv/pyenv) for Python,
[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
Eclectica unifies management of any language under one cohesive and minimalistic interface. Like [pyenv](https://github.com/pyenv/pyenv) for Python,
[rbenv](https://github.com/rbenv/rbenv) for Ruby, [nvm](https://github.com/creationix/nvm) Node.js and etc.

# Install
But instead of having all of those you have only one binary

## Usage

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 -

```
$ ec --help
Usage:
ec [command] [flags] [<language>@<version>]
Examples:
Install specifc version
$ ec [email protected]
Choose local version with interactive list
$ ec go
Choose remote version with interactive list
$ ec -r rust
Available Commands:
completion generate the autocompletion script for the specified shell
install same as "ec [<language>@<version>]"
ls list installed language versions
remove-everything removes everything related to eclectica
rm remove language version
version print version of eclectica
Flags:
-h, --help help for ec
Use "ec [command] --help" for more information about a command
```

## Install

Since eclectica is language manager for any language, it should be installed through any package manager :-)

- [go get](#go-get)
- [npm](#npm)
Expand Down

0 comments on commit 622adb0

Please sign in to comment.