Skip to content

Commit

Permalink
Adds goreleaser and edits readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
ackleymi committed Jun 25, 2018
1 parent 2a549b3 commit 230f227
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 16 deletions.
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,19 @@ The official cli tool for making financial markets analysis as fast as you are.

## Commands
The current available commands are:
* `equity` Prints tables of equity quotes to the current shell :ledger:
* `equity` - prints tables of equity quotes to the current shell

## Installation
In order to use this awesome tool, you'll need to get it on your machine!

### Download Distribution
### From Homebrew
If you're on macOS, the easiest way to get qtrn is through the homebrew tap.
```
brew tap piquette/qtrn
brew install qtrn
```

### From Release
1. Head over to the official [releases page](https://github.com/piquette/qtrn/releases)
2. Determine the appropriate distribution for your operating system (mac | windows | linux)
3. Download and untar the distribution. Shortcut for macs:
Expand All @@ -24,28 +31,20 @@ curl -sL https://github.com/piquette/qtrn/releases/download/v0.5.1/qtrn-0.5.1-da
5. Run `qtrn help`.

### From Source
qtrn is built in Go. To get started with Go, head to the official instructions [here](https://golang.org/doc/install). A common way to install go is through pacakge manager [homebrew](https://brew.sh/) using the command:

```
brew install go
```

You will also need Glide, a Go dependency management tool. It can be installed simply:

```
brew install glide
```

Next, you'll want to `go get` the source repo, like this:
qtrn is built in Go. `go get` the source repo, like this:

```
go get github.com/piquette/qtrn
```

If your `$GOPATH` is configured, and git is setup to know your credentials, in a few moments the command should complete with no output. The repository will exist under `$GOPATH/src/github.com/piquette`.


## Usage
Run the command `qtrn` in your shell for the list of possible commands.

### Example
The

The preferred way to build qtrn for development is using `make`. Run `make dev && qtrn help` which builds the project, moves the binary into `$GOPATH/bin/` and lists possible commands.

### Contributing
Expand Down
44 changes: 44 additions & 0 deletions goreleaser.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
build:
binary: qtrn
goos:
- windows
- darwin
- linux
goarch:
- amd64

brew:
github:
owner: piquette
name: homebrew-qtrn
homepage: "https://github.com/piquette/qtrn"
description: "qtrn is a tool for printing financial markets data to the console and writing data to files."

plist: |
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>KeepAlive</key>
<dict>
<key>SuccessfulExit</key>
<false/>
</dict>
<key>Label</key>
<string>#{plist_name}</string>
<key>ProgramArguments</key>
<array>
<string>#{opt_bin}/qtrn</string>
<string>-port</string>
<string>12111</string>
</array>
<key>RunAtLoad</key>
<true/>
<key>WorkingDirectory</key>
<string>#{var}</string>
<key>StandardErrorPath</key>
<string>#{var}/log/qtrn.log</string>
<key>StandardOutPath</key>
<string>#{var}/log/qtrn.log</string>
</dict>
</plist>

0 comments on commit 230f227

Please sign in to comment.