msw

command module
Version: v0.0.0-...-5d55774 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 17, 2017 License: MIT Imports: 7 Imported by: 0

README

msw

Circle CI

msw is a small tool that powers the ModernScienceWeekly newsletter, written in Go. This is a full rewrite of one of our internal tools we did in order to learn the Go language, which we also decided to open source. You can find our blog post about this very first experience:

Usage

  1. Install the msw command

  2. (optionally) create a configuration file ~/.msw/msw.toml:

    # ~/.msw/msw.toml
    [buffer]
    AccessToken = "BUFFER_ACCESS_TOKEN"
    ProfileIDs  = ["BUFFER_PROFILE_ID"]
    
  3. Run msw:

    $ msw
    usage: msw [--version] [--help] <command> [<args>]
    
    Available commands are:
        buffer
        generate    generate HTML for Tinyletter from a YAML file
        new         create a new empty YAML file to prepare a new issue
        validate    check that an issue is valid
    

Installation

$ go get github.com/TailorDev/msw

Alternatively, you can download pre-compiled packages: https://github.com/TailorDev/msw/releases.

Development and Testing

If you wish to work on msw itself, you'll first need Go installed (version 1.6+ is required). Make sure you have Go properly installed, including setting up your GOPATH.

Next, clone this repository into $GOPATH/src/github.com/TailorDev/msw, and run:

$ go install

You can run the test suite with the following command:

$ go test ./... [-cover]

You can build packages with gox:

$ go get github.com/mitchellh/gox
...
$ gox -osarch="darwin/amd64 linux/amd64" -output="pkg/msw_{{.OS}}_{{.Arch}}"
Number of parallel builds: 1

-->    darwin/amd64: github.com/TailorDev/msw
-->     linux/amd64: github.com/TailorDev/msw

License

msw is released under the MIT License. See the bundled LICENSE file for details.

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
Package config contains the code to read user's configuration.
Package config contains the code to read user's configuration.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL