Skip to content

Commit

Permalink
Use some HTML to make the README pretty
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeljs1990 authored Apr 8, 2020
1 parent 3426411 commit 366e500
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Collins Golang CLI
==================
<h1 align="center">Collins CLI</h1>

Command line interface for interacting with https://tumblr.github.io/collins/
<p align="center">Command line interface for interacting with https://tumblr.github.io/collins/</p>

## Install
### Install

You can always install from the releases page on github or if you want you can also stay up to date
using the `go get` method. My server can be a little slow sometimes but it works just fine if you wait.
Expand All @@ -12,7 +11,7 @@ using the `go get` method. My server can be a little slow sometimes but it works
go get -u cgit.xrt0x.com/xrt0x/collins-go-cli/cmd/collins
```

## Config file
### Config file

In order to talk to collins you will need to create a `~/.collins.yml` file with the following fields.

Expand All @@ -25,11 +24,11 @@ password: test
**NOTE**: if you do not have the password saved in `~/.collins.yml`, the client will prompt for a password
at runtime. But, this will error and fail, if the collins command is being piped from one collins command to next.

## Documentation
### Documentation

All docs can be found in markdown under `collins/docs/`.

## Development
### Development

You can easily build this by cloning the repo and running `go build -mod=vendor ./cmd/collins`. Additionally
the most recent tags will have binaries uploaded for most common and some uncommon platforms
Expand Down

0 comments on commit 366e500

Please sign in to comment.