Skip to content

Commit

Permalink
Merge pull request #25 from Jyny/dev
Browse files Browse the repository at this point in the history
change cd in makefile
  • Loading branch information
Jyny authored Sep 6, 2019
2 parents 40b1812 + 7fdf561 commit 404a607
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 21 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ build : mod embedded fmt
env GOOS=windows GOARCH=amd64 go build -o ./build/$(WINDOWS) -ldflags="-X $(XPKG).version=$(VERSION)" .

embedded :
@pushd pkg/deployer/ssh > /dev/null && \
go run gen/gen.go \
&& popd > /dev/null
@cd pkg/deployer/ssh; \
go run gen/gen.go; \
cd ../../../

fmt :
gofmt -w ./
Expand Down
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ Use "outliner [command] --help" for more information about a command.
- [2. Make a `.env` config file](#2-make-a-env-config-file)
- [3. Ready to go](#3-ready-to-go)
- [Configurations](#configurations)
- [config by `.env` file](#config-by-env-file)
- [config by Environment Variables](#config-by-environment-variables)
- [Support `TOKEN_NAME`](#support-token_name)
- [Support configuration source](#support-configuration-source)
- [config by `.env` file](#config-by-env-file)
- [config by Environment Variables](#config-by-environment-variables)
- [Support Cloud(IaaS)](#support-cloudiaas)
- [Development and Build](#development-and-build)

Expand Down Expand Up @@ -79,7 +79,7 @@ TOKEN_NAME_2 = TOKEN_VALUE_2
```

#### 3. Ready to go
* install by package manager like `homeberw` `pacman` `apt` etc.
* install by package manager like `homeberw` `yay` `snap` etc.
1. `$ outliner`

* install by download
Expand All @@ -88,19 +88,6 @@ TOKEN_NAME_2 = TOKEN_VALUE_2
3. `$ ./outliner_{OS}`

## Configurations
### config by `.env` file
* `~/.outliner/.env`
```
TOKEN_NAME_1 = TOKEN_VALUE_1
TOKEN_NAME_2 = TOKEN_VALUE_2
...
```

### config by Environment Variables
```
$ {TOKEN_NAME_1}={TOKEN_VALUE_1} outliner [command]
```

### Support `TOKEN_NAME`
| Provider | TOKEN_NAME |
| -------------|--------------------|
Expand All @@ -110,7 +97,6 @@ $ {TOKEN_NAME_1}={TOKEN_VALUE_1} outliner [command]
| Digitalocean | |
| Vultr | |


find full list in `pkg/cloud/{ProviderNmae}/activator.go` as below
```
var tokenNames = []string{
Expand All @@ -128,11 +114,24 @@ outliner Support the following configuration source (list by Precedence order)
4. `.env` file at `~/`
5. `.env` file at `./`

### config by `.env` file
* `~/.outliner/.env`
```
TOKEN_NAME_1 = TOKEN_VALUE_1
TOKEN_NAME_2 = TOKEN_VALUE_2
...
```

### config by Environment Variables
```
$ {TOKEN_NAME_1}={TOKEN_VALUE_1} outliner [command]
```

## Support Cloud(IaaS)
* Linode
* DigitalOcean (WIP)
* Vultr (WIP)
...
* ...

## Development and Build
#### 1. install package and build binary
Expand Down

0 comments on commit 404a607

Please sign in to comment.