Skip to content

Commit

Permalink
Update readme install guide with new makedown examples
Browse files Browse the repository at this point in the history
  • Loading branch information
NobleMajo committed Aug 29, 2024
1 parent 25e4643 commit c6b9f39
Showing 1 changed file with 25 additions and 18 deletions.
43 changes: 25 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@ The idea behind this tool is to have a CLI utility that can quickly and easily e
- [Encryption](#encryption)
- [Getting Started](#getting-started)
- [Requirements](#requirements)
- [via wget](#via-wget)
- [via go](#via-go)
- [Install via go](#install-via-go)
- [Install via wget](#install-via-wget)
- [Build](#build)
- [Build requirements](#build-requirements)
- [Install go](#install-go)
- [Usage](#usage)
- [Help](#help)
- [init](#init)
Expand All @@ -32,6 +31,7 @@ The idea behind this tool is to have a CLI utility that can quickly and easily e
- [Other filename](#other-filename)
- [Build](#build-1)
- [Development](#development)
- [Install go](#install-go)
- [Contributing](#contributing)
- [License](#license)
- [Disclaimer](#disclaimer)
Expand All @@ -53,9 +53,15 @@ Currently no elliptic curve support! Just rsa.

## Requirements
None windows system with `go` or `wget & tar` installed.
The required go version is in the `go.mod` file.

## via wget
## Install via go
###### *For this section go is required, check out the [install go guide](#install-go).*

```sh
go install https://github.com/NobleMajo/vault
```

## Install via wget
```sh
BIN_DIR="/usr/local/bin"
VAULT_VERSION="1.3.3"
Expand All @@ -66,24 +72,11 @@ tar -xzvf /tmp/vault.tar.gz -C $BIN_DIR/ vault
rm /tmp/vault.tar.gz
```

## via go
```sh
go install https://github.com/NobleMajo/vault
```

# Build
## Build requirements
To build, you need to install go.
The required go version is in the `go.mod` file.

## Install go
To install go, I can recommend the following repo:
```sh
git clone git@github.com:udhos/update-golang.git golang-updater
cd golang-updater
sudo ./update-golang.sh
```

# Usage
Vault operations are sub commands defined via the first command line argument.

Expand Down Expand Up @@ -163,6 +156,8 @@ vault print <filename>
```

## Build
###### *For this section go is required, check out the [install go guide](#install-go).*

Clone the repo:
```sh
git clone https://github.com/NobleMajo/vault.git
Expand All @@ -176,11 +171,23 @@ make build
```

# Development
###### *For this section go is required, check out the [install go guide](#install-go).*

This part is work in process, i want use 'AIR' as autoreload tool:
```sh
make dev #WIP
```

## Install go
The required go version for this project is in the `go.mod` file.

To install and update go, I can recommend the following repo:
```sh
git clone git@github.com:udhos/update-golang.git golang-updater
cd golang-updater
sudo ./update-golang.sh
```

# Contributing
Contributions to Vault are welcome!
Interested users can refer to the guidelines provided in the [CONTRIBUTING.md](CONTRIBUTING.md) file to contribute to the project and help improve its functionality and features.
Expand Down

0 comments on commit c6b9f39

Please sign in to comment.