From 698b0406c8eee911132601aa5992ee651152e43f Mon Sep 17 00:00:00 2001 From: James Hillyerd Date: Wed, 23 Sep 2020 20:43:51 -0700 Subject: [PATCH] Readme updates (#183) * Add docker build badge * Rephrase things * add dev guide link * Remove brew tap section until #68 is fixed --- README.md | 62 +++++++++++++++++++++++++++---------------------------- 1 file changed, 30 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index b7673d3..013cf08 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ Inbucket ============================================================================= [![Build Status](https://travis-ci.org/inbucket/inbucket.png?branch=master)][Build Status] +[![Docker Image](https://github.com/inbucket/inbucket/workflows/Docker%20Image/badge.svg)][Docker Image] Inbucket is an email testing service; it will accept messages for any email -address and make them available via web, REST and POP3. Once compiled, -Inbucket does not have any external dependencies (HTTP, SMTP, POP3 and storage -are all built in). +address and make them available via web, REST and POP3 interfaces. Once +compiled, Inbucket does not have any external dependencies - HTTP, SMTP, POP3 +and storage are all built in. A Go client for the REST API is available in `github.com/inbucket/inbucket/pkg/rest/client` - [Go API docs] @@ -14,6 +15,7 @@ Read more at the [Inbucket Website] ![Screenshot](http://www.inbucket.org/images/inbucket-ss1.png "Viewing a message") + ## Development Status Inbucket is currently production quality: it is being used for real work. @@ -29,15 +31,6 @@ tracks our `master` branch (releases), `latest` tracks our unstable `development` branch. -## Homebrew Tap - -(currently broken, being tracked in [issue -#68](https://github.com/inbucket/inbucket/issues/68)) - -Inbucket has an OS X [Homebrew] tap available as [jhillyerd/inbucket][Homebrew Tap], -see the `README.md` there for installation instructions. - - ## Building from Source You will need functioning [Go] and [Node.js] installations for this to work. @@ -45,17 +38,20 @@ You will need functioning [Go] and [Node.js] installations for this to work. ```sh git clone https://github.com/inbucket/inbucket.git cd inbucket/ui -npm i +npm ci npm run build cd .. go build ./cmd/inbucket ``` -_Note:_ You may also use the included Makefile to build and test the Go binaries. +For more information on building and development flows, check out the +[Development Quickstart] page of our wiki. + +### Configure and Launch Inbucket reads its configuration from environment variables, but comes with -built in sane defaults. It should work on most Unix and OS X machines as is. -Launch the daemon: +reasonable defaults built-in. It should work on most Unix and OS X machines as +is. Launch the daemon: ```sh ./inbucket @@ -65,27 +61,29 @@ By default the SMTP server will be listening on localhost port 2500 and the web interface will be available at [localhost:9000](http://localhost:9000/). See doc/[config.md] for more information on configuring Inbucket, but you will -likely find the [Configurator] tool easier to use. +likely find the [Configurator] tool the easiest way to generate a configuration. ## About -Inbucket is written in [Go] +Inbucket is written in [Go] and [Elm]. Inbucket is open source software released under the MIT License. The latest version can be found at https://github.com/inbucket/inbucket -[Build Status]: https://travis-ci.org/inbucket/inbucket -[Change Log]: https://github.com/inbucket/inbucket/blob/master/CHANGELOG.md -[config.md]: https://github.com/inbucket/inbucket/blob/master/doc/config.md -[Configurator]: https://www.inbucket.org/configurator/ -[CONTRIBUTING.md]: https://github.com/inbucket/inbucket/blob/develop/CONTRIBUTING.md -[Docker Image]: https://www.inbucket.org/binaries/docker.html -[From Source]: https://www.inbucket.org/installation/from-source.html -[Go]: https://golang.org/ -[Go API docs]: https://godoc.org/github.com/inbucket/inbucket/pkg/rest/client -[Homebrew]: http://brew.sh/ -[Homebrew Tap]: https://github.com/inbucket/homebrew-inbucket -[Inbucket Website]: https://www.inbucket.org/ -[Issues List]: https://github.com/inbucket/inbucket/issues?state=open -[Node.js]: https://nodejs.org/en/ +[Build Status]: https://travis-ci.org/inbucket/inbucket +[Change Log]: https://github.com/inbucket/inbucket/blob/master/CHANGELOG.md +[config.md]: https://github.com/inbucket/inbucket/blob/master/doc/config.md +[Configurator]: https://www.inbucket.org/configurator/ +[CONTRIBUTING.md]: https://github.com/inbucket/inbucket/blob/develop/CONTRIBUTING.md +[Development Quickstart]: https://github.com/inbucket/inbucket/wiki/Development-Quickstart +[Docker Image]: https://www.inbucket.org/binaries/docker.html +[Elm]: https://elm-lang.org/ +[From Source]: https://www.inbucket.org/installation/from-source.html +[Go]: https://golang.org/ +[Go API docs]: https://pkg.go.dev/github.com/inbucket/inbucket/pkg/rest/client +[Homebrew]: http://brew.sh/ +[Homebrew Tap]: https://github.com/inbucket/homebrew-inbucket +[Inbucket Website]: https://www.inbucket.org/ +[Issues List]: https://github.com/inbucket/inbucket/issues?state=open +[Node.js]: https://nodejs.org/en/