Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,51 @@
Blues Wireless CLI Utilities
============================
# Notecard & Notehub CLI

This repository contains command-line tools for working with the Notecard and Notehub.io.
This repository contains command-line tools for working with the Notecard and Notehub CLI utilities.

## Installing

The Notecard & Notehub CLIs can be installed either with a package manager (`homebrew`) or by downloading the binaries from the [releases page](https://github.com/blues/note-cli/releases).

### Homebrew

```bash
brew tap blues/note-cli
brew install note-cli
```

### Downloading the binaries

For all releases, we have compiled the Notecard and Notehub utilities for different OS and architectures [here](https://github.com/blues/note-cli/releases).

If you don't see your OS and architecture supported, please file an issue and we'll add it to new releases.

## Dependencies
## Building the CLIs

### Dependencies

- Install Go and the Go tools [(here)](https://golang.org/doc/install)

## Compiling the utilities
### Compiling the utilities

If you want to build the latest, follow the directions below.

```bash
$ cd notecard
$ go build .
cd notecard
go build .
```

```bash
$ cd notehub
$ go build .
cd notehub
go build .
```

## To learn more about Blues Wireless, the Notecard and Notehub, see:
## Additional Resources

To learn more about Blues Wireless, the Notecard and Notehub, see:

* [blues.com](https://blues.io)
* [notehub.io](https://notehub.io)
* [wireless.dev](https://wireless.dev)
- [blues.com](https://blues.io)
- [notehub.io](https://notehub.io)
- [wireless.dev](https://wireless.dev)

## License

Expand Down