From 5174e7216b66b2d58904bf83d96c34c7aa6253a5 Mon Sep 17 00:00:00 2001 From: James Wrigley Date: Mon, 8 Jul 2024 21:35:10 +0200 Subject: [PATCH] Update the README (#243) - Add coverage badge - Remove old mentions of ZMQBuilder.jl and Windows issue - Fix links --- README.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 3137d49..825fe54 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ *A Julia interface to ZeroMQ* -| **Documentation** | -|:-------------------------------------------------------------------------:| -| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | +| **Documentation** | **Coverage** | +|:-------------------------------------------------------------------------:|:-------------------------------:| +| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![][codecov-img]][codecov-url] | **ZMQ.jl** is a [Julia](http://julialang.org) interface to [ZeroMQ, The Intelligent Transport Layer](http://zeromq.org). @@ -23,26 +23,22 @@ Or, equivalently, via the `Pkg` API: julia> import Pkg; Pkg.add("ZMQ") ``` -(This installs its own copy of the ZMQ libraries from the [ZMQBuilder](https://github.com/JuliaInterop/ZMQBuilder) repository.) - ## Documentation - [**STABLE**][docs-stable-url] — **documentation of the most recently tagged version.** - [**DEVEL**][docs-dev-url] — *documentation of the in-development version.* -## Troubleshooting - -If you are using Windows and get an error `Provider PackageManager failed to satisfy dependency zmq`, you may need to restart Julia and run `Pkg.build("ZMQ")` again. See [issue #69](https://github.com/JuliaLang/ZMQ.jl/issues/69) for more details. - ## Questions and Contributions -Usage questions can be posted on the [Julia Discourse forum][discourse-tag-url] under the `zmq` tag, in the #zmq channel of the [Julia Slack](https://julialang.org/community/) and/or in the [JuliaDocs Gitter chat room][gitter-url]. +Usage questions can be posted on the [Julia Discourse forum][discourse-tag-url] +under the `zmq` tag, in the `#helpdesk` channel of the [Julia +Slack](https://julialang.org/community/), or the `#helpdesk`/`#helpdesk +(published)` stream of the [Julia Zulip](https://julialang.zulipchat.com/). -Contributions are very welcome, as are feature requests and suggestions. Please open an [issue][issues-url] if you encounter any problems. The [contributing page][contrib-url] has a few guidelines that should be followed when opening pull requests and contributing code. +Contributions are very welcome, as are feature requests and suggestions. Please +open an [issue][issues-url] if you encounter any problems. -[contrib-url]: https://juliadocs.github.io/Documenter.jl/latest/man/contributing/ [discourse-tag-url]: https://discourse.julialang.org/tags/zmq -[gitter-url]: https://gitter.im/juliadocs/users [docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg [docs-dev-url]: https://juliainterop.github.io/ZMQ.jl/latest @@ -50,13 +46,7 @@ Contributions are very welcome, as are feature requests and suggestions. Please [docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg [docs-stable-url]: https://juliainterop.github.io/ZMQ.jl/stable -[travis-img]: https://api.travis-ci.org/JuliaInterop/ZMQ.jl.svg -[travis-url]: https://travis-ci.org/JuliaInterop/ZMQ.jl - -[appveyor-img]: https://ci.appveyor.com/api/projects/status/u1d6dpovaptdqalh?svg=true -[appveyor-url]: https://ci.appveyor.com/project/StevenGJohnson/zmq-jl - -[codecov-img]: https://codecov.io/gh/JuliaDocs/Documenter.jl/branch/master/graph/badge.svg -[codecov-url]: https://codecov.io/gh/JuliaDocs/Documenter.jl +[codecov-img]: https://codecov.io/gh/JuliaInterop/ZMQ.jl/graph/badge.svg?token=NMxuhZepAU +[codecov-url]: https://codecov.io/gh/JuliaInterop/ZMQ.jl -[issues-url]: https://github.com/JuliaDocs/Documenter.jl/issues +[issues-url]: https://github.com/JuliaInterop/ZMQ.jl/issues