Skip to content

Use the CI badge for the main branch, fix typo #17

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
JosephusPaye merged 1 commit into from
Feb 14, 2022
Merged

Use the CI badge for the main branch, fix typo #17

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NUClearNet.js

[![Node.js CI](https://github.com/Fastcode/NUClearNet.js/actions/workflows/node.js.yml/badge.svg)](https://github.com/Fastcode/NUClearNet.js/actions/workflows/node.js.yml)
[![Node.js CI](https://github.com/Fastcode/NUClearNet.js/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/Fastcode/NUClearNet.js/actions/workflows/node.js.yml)

Node.js module for interacting with the [NUClear](https://github.com/Fastcode/NUClear) network.

Expand All @@ -14,7 +14,7 @@ npm install nuclearnet.js --save

## Usage

The following example show a typical usage pattern of creating a network instance, listening for join, leave, and packet events, and sending data.
The following example shows a typical usage pattern of creating a network instance, listening for join, leave, and packet events, and sending data.

```js
const { NUClearNet } = require('nuclearnet.js');
Expand Down