Skip to content

docs: improve README with badges and examples #58

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
Open
joshrotenberg wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve README with badges and examples #58

joshrotenberg wants to merge 1 commit into from
+159 −19

Conversation

@joshrotenberg
Copy link

@joshrotenberg joshrotenberg commented Dec 9, 2025

  • Add crates.io, docs.rs, and license badges
  • Expand examples section with practical use cases:
    • Accessing nested data
    • Array indexing and slicing
    • Projections and filtering
    • Built-in functions (length, sum, max, min)
    • Multi-select and object creation
  • Add CLI tool installation instructions
  • Add links to JMESPath specification and tutorial
  • Use modern dependency syntax in Cargo.toml examples

@joshrotenberg
docs: improve README with badges and examples
faded60 
- Add crates.io, docs.rs, and license badges
- Expand examples section with practical use cases:
  - Accessing nested data
  - Array indexing and slicing
  - Projections and filtering
  - Built-in functions (length, sum, max, min)
  - Multi-select and object creation
- Add CLI tool installation instructions
- Add links to JMESPath specification and tutorial
- Use modern dependency syntax in Cargo.toml examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@joshrotenberg