Skip to content
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

Jump to bottom

docs-style: Note notation uses new gtihub feature #10

Merged
merged 1 commit into from Aug 26, 2022
Merged

docs-style: Note notation uses new gtihub feature #10

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Expand Up @@ -158,7 +158,8 @@ Clients let you interact with the agents. They send commands to agents via the b
## Getting Started
The simplest way to use Sidekick is to create an account on Sidekick Cloud. For the self-hosted version, you can either build Sidekick yourself or use our Docker image.

Note: Make sure docker daemon is running.
> **Note**
> Make sure docker daemon is running.

### Running Sidekick using our Docker image

Expand Down Expand Up @@ -250,8 +251,10 @@ Check out [docs](https://docs.runsidekick.com/) to learn how you can use clients

- ##### Sidekick Node.js Client:
[Sidekick Node Client](https://www.npmjs.com/package/@runsidekick/sidekick-client) opens up a new & headless way to use Sidekick. It allows you to both use custom ingest functions for the **tracepoint** or **logpoint** events and put/edit/delete your tracepoints/logpoints easily using code.

> **Note**
> This can be used with agents from all runtimes.

Note: This can be used with agents from all runtimes.

- ##### REST API
[Sidekick REST API Doc](https://api.service.runsidekick.com/swagger-ui.html)
Expand Down