Skip to content

Commit

Permalink
Chore: Added badges (#170)
Browse files Browse the repository at this point in the history
  • Loading branch information
kjy5 authored Jul 17, 2023
1 parent d65303c commit ba74770
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Electrophysiology Manipulator Link

[![Autoformat and Lint](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/autoformat-and-lint.yml/badge.svg)](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/autoformat-and-lint.yml)
[![CodeQL](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/codeql-analysis.yml)
[![Dependency Review](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/VirtualBrainLab/ephys-link/actions/workflows/dependency-review.yml)

The Electrophysiology Manipulator Link (or Ephys Link for short) is a Python
WebSocket server that allows any WebSocket-compliant application (such
as [Pinpoint (electrophysiology planning tool)][Pinpoint])
Expand Down Expand Up @@ -29,8 +33,7 @@ added in the future.
## Installation

1. Ensure Python 3.10+ and pip are installed
2. `pip install ephys-link --use-pep517`
1. PEP 517 is needed to allow the Sensapex Manipulator API to be installed
2. `pip install ephys-link`
3. Run `python -m ephys_link` to start the server
1. To view available command-line arguments,
run `python -m ephys_link --help`
Expand Down

0 comments on commit ba74770

Please sign in to comment.