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

Update README.md Examples #3

Closed
junderhill opened this issue Mar 28, 2023 · 1 comment · Fixed by #6
Closed

Update README.md Examples #3

junderhill opened this issue Mar 28, 2023 · 1 comment · Fixed by #6
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@junderhill
Copy link
Owner

Examples within the README are still referencing the dynamo package even though the imports in the examples have been updated.
@junderhill junderhill added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 28, 2023
@junderhill
Copy link
Owner Author

As part of this work it'd be nice to overhaul the README to better summarise the core features and benefits:

  • Handing of pagination
  • Batching
  • More readable/expressive code
  • etc.

junderhill added a commit that referenced this issue Apr 14, 2023
@junderhill
📝 README and License Updates #3
0565700 
Update the LICENSE to retain existing copyright information but include
new copyright.
Update README to change references to original GoDocs and any missed
references to original package. Also added list of benefits of Helixddb
@junderhill junderhill linked a pull request Apr 14, 2023 that will close this issue
📝 README and License Updates #3 #6
Merged
junderhill added a commit that referenced this issue Apr 14, 2023
@junderhill
Merge pull request #6 from junderhill/3-update-readmemd
bf1d210 
📝 README and License Updates #3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

📝 README and License Updates #3 junderhill/helixddb
1 participant
@junderhill