Skip to content
This repository was archived by the owner on Sep 5, 2025. It is now read-only.

chore: add examples#89

Merged
ryanfoxtyler merged 3 commits intomainfrom
matthewmcneely/add-examples
Apr 30, 2025
Merged

chore: add examples#89
ryanfoxtyler merged 3 commits intomainfrom
matthewmcneely/add-examples

Conversation

@matthewmcneely
Copy link
Contributor

Description

This PR adds a few examples and updates the README

Checklist

  • Code compiles correctly and linting passes locally

@matthewmcneely matthewmcneely requested review from a team and Copilot April 30, 2025 01:39
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the repository with practical examples and updates the documentation to guide users on using modusGraph.

  • Adds a new example featured in the README.
  • Introduces a complete CLI example demonstrating CRUD operations.
  • Updates the top-level README to include installation instructions and known limitations.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
examples/readme/main.go Adds an example comment for showcasing usage in the README.
examples/basic/main.go Provides a basic CLI example with complete CRUD functionality.
examples/basic/README.md Documents the usage of the basic CLI example.
README.md Updates general documentation and adds a Limitations section.
Comments suppressed due to low confidence (1)

README.md:25

  • Typo: 'runnning' should be corrected to 'running'.
and vector searches. We’ve made trade-offs to prioritize speed and simplicity. When runnning

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@ryanfoxtyler ryanfoxtyler merged commit c172857 into main Apr 30, 2025
7 checks passed
@ryanfoxtyler ryanfoxtyler deleted the matthewmcneely/add-examples branch April 30, 2025 11:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants