Skip to content

Commit

Permalink
chore: add installation script, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
vst committed Feb 17, 2021
1 parent a5d5cd7 commit a59935f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ files under given directories based on a set of regex-powered rules.
There are no specific requirements for the application to run other
than `>= Python3.6`.

## Installation

```
curl -o - https://raw.githubusercontent.com/telostat/reforg/main/reforg/install.sh | sudo sh -x
```

## Usage

CLI arguments are as follows:

```
Expand Down Expand Up @@ -61,4 +69,3 @@ argument):
```
yq . < example/spec.yaml | ./reforg --spec - --root example/target/ --metadata --force --dry-run example/source/
```

15 changes: 15 additions & 0 deletions install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/usr/bin/env sh

set -e

## Target installation directory:
REFORG_INSTALL_DIR="${REFORG_INSTALL_DIR:-"/usr/local/bin"}"

## Download the script:
curl -s -o - https://raw.githubusercontent.com/telostat/reforg/main/reforg > "${REFORG_INSTALL_DIR}/reforg"

## Change file permissions:
chmod +x "${REFORG_INSTALL_DIR}/reforg"

## Run:
reforg --help

0 comments on commit a59935f

Please sign in to comment.