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 44391f0
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 12 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
6 changes: 3 additions & 3 deletions cmd/commands/rm/rm.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ var Command = &cobra.Command{

// Command example
var example = `
Install specifc version
Remove specifc version
$ ec rm [email protected]
Remove language version with interactive list
Remove language version via interactive list
$ ec rm go
Remove with interactive list
Remove via interactive list
$ ec rm`

// Runner
Expand Down
6 changes: 3 additions & 3 deletions cmd/commands/templates.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ package commands

// Command example for install command
const example = `
Install specifc version
Install specifc, say, node version
$ ec [email protected]
Choose local version with interactive list
Or choose from already installed Go versions
$ ec go
Choose remote version with interactive list
Same way to choose, plus install available Rust versions
$ ec -r rust`

// Help output
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
46 changes: 42 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,50 @@
</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, say, node version
$ ec [email protected]
Or choose from already installed Go versions
$ ec go
Same way to choose, plus install available Rust versions
$ 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 44391f0

Please sign in to comment.