Skip to content

doc: clarifies usage of pass #12

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
bougyman merged 1 commit into from
Jan 5, 2026
Merged

doc: clarifies usage of pass #12

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
23 changes: 22 additions & 1 deletion Readme.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Kalshi
:toc: macro
:icons: font

Ruby client for the Kalshi API.

Expand Down Expand Up @@ -168,7 +169,7 @@ Get tags organized by series categories:

[source,ruby]
----
tags = client.search.tags_by_category
tags = client.search.tags_by_categories
----

==== Filters by Sport
Expand All @@ -192,13 +193,33 @@ NOTE: If you aren't using `pass` yet, you should! It works on Windows, Android,

[source,bash]
----
# Set up your pass entry at the default path
printf '%s\n\n%s\n' "$API_KEY" "$PEM_PRIVATE_KEY" | pass insert -m kalshi/api/initial-dev-ro

# Default pass path: kalshi/api/initial-dev-ro
./bin/wss-raw

# Set up your pass entry at a custom path
printf '%s\n\n%s\n' "$API_KEY" "$PEM_PRIVATE_KEY" | pass insert -m my/custom/path

# Override pass path
KALSHI_PASS_PATH=my/custom/path ./bin/wss-raw
----

[IMPORTANT]
.The "$PEM_PRIVATE_KEY" must include the BEGIN and END lines
====
For example:

[source]
----
-----BEGIN RSA PRIVATE KEY-----
MIIEvQIBADANBgkqhkiG9w0BAQEFAASC...
-----END RSA PRIVATE KEY-----
----
====


Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are two consecutive blank lines here (221 and 222). The document style uses single blank lines to separate sections. Consider removing one blank line to maintain consistency with the rest of the document.

Suggested change

Copilot uses AI. Check for mistakes.
== Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand Down