Skip to content

Update HexDoc URL #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fhunleth merged 1 commit into from
Jun 2, 2026
Merged

Update HexDoc URL #222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Circuits.UART

[![Hex version](https://img.shields.io/hexpm/v/circuits_uart.svg "Hex version")](https://hex.pm/packages/circuits_uart)
[![API docs](https://img.shields.io/hexpm/v/circuits_uart.svg?label=hexdocs "API docs")](https://hexdocs.pm/circuits_uart/Circuits.UART.html)
[![API docs](https://img.shields.io/hexpm/v/circuits_uart.svg?label=hexdocs "API docs")](https://circuits-uart.hexdocs.pm/Circuits.UART.html)
[![CI](https://github.com/elixir-circuits/circuits_uart/actions/workflows/ci.yml/badge.svg)](https://github.com/elixir-circuits/circuits_uart/actions/workflows/ci.yml)
[![REUSE status](https://api.reuse.software/badge/github.com/elixir-circuits/circuits_uart)](https://api.reuse.software/info/github.com/elixir-circuits/circuits_uart)

Expand All @@ -21,7 +21,7 @@ the same. Update your project by replacing all references to `nerves_uart` and
`Nerves.UART` to `circuits_uart` and `Circuits.UART` and you should be good.

Something doesn't work for you? Check out below and the
[docs](https://hexdocs.pm/circuits_uart/). Post a question on the [Elixir
[docs](https://circuits-uart.hexdocs.pm/). Post a question on the [Elixir
Forum](https://elixirforum.com/) or file an issue or PR.

## Example use
Expand Down Expand Up @@ -320,7 +320,7 @@ out how to work around.

### How does Circuits.UART communicate with the serial port?

Circuits.UART uses a [Port](https://hexdocs.pm/elixir/Port.html) and C code.
Circuits.UART uses a [Port](https://elixir.hexdocs.pm/Port.html) and C code.
Elixir/Erlang ports have nothing to do with the serial ports of the operating
system. They share the same name but are different concepts.

Expand All @@ -337,7 +337,7 @@ To disable this "pollution" you will have to edit:

To learn how to edit those files in your nerves setup you can check the advanced
configuration documentation of nerves:
https://hexdocs.pm/nerves/advanced-configuration.html#overwriting-files-in-the-root-filesystem
https://nerves.hexdocs.pm/advanced-configuration.html#overwriting-files-in-the-root-filesystem

## Acknowledgments

Expand Down
Loading