Skip to content

docs: add Get Started section to README#266

Merged
LorrisSaintGenez merged 1 commit into
mainfrom
chore/readme-get-started
Jul 14, 2026
Merged

docs: add Get Started section to README#266
LorrisSaintGenez merged 1 commit into
mainfrom
chore/readme-get-started

Conversation

@LorrisSaintGenez

@LorrisSaintGenez LorrisSaintGenez commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

What

  • Add a "Get started" section to the README: sign in (algolia auth login), choose an application (list / select / create), and a first index + search micro-action.
  • Add a short note in CONTRIBUTING.md on how to run the locally built binary (./algolia your_command ...).

GROUT-327

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes.

@LorrisSaintGenez LorrisSaintGenez self-assigned this Jul 13, 2026
@LorrisSaintGenez LorrisSaintGenez marked this pull request as ready for review July 13, 2026 19:06
@LorrisSaintGenez LorrisSaintGenez requested review from a team and dylantientcheu and removed request for a team July 13, 2026 21:21
@LorrisSaintGenez LorrisSaintGenez merged commit dd71e3b into main Jul 14, 2026
3 checks passed
@LorrisSaintGenez LorrisSaintGenez deleted the chore/readme-get-started branch July 14, 2026 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants