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

docs: create project README.md #84

Closed
mhordynski opened this issue Oct 10, 2024 · 0 comments · Fixed by #103
Closed

docs: create project README.md #84

mhordynski opened this issue Oct 10, 2024 · 0 comments · Fixed by #103
Assignees
@ludwiktrammer
Labels
docs Improvements or additions to documentation
Milestone
Ragbits 0.2

Comments

@mhordynski
Copy link
Member

mhordynski commented Oct 10, 2024 •
edited
Loading

Structure of readme:

Ragbits Banner
[] [] [] [] badges

1-2 sentences + key features

[video will be here at later point]

Quickstart (with installation)

Documentation

License

Roadmap
@mhordynski mhordynski moved this to Backlog in ragbits Oct 10, 2024
@mhordynski mhordynski moved this from Backlog to Ready in ragbits Oct 10, 2024
@mhordynski mhordynski added this to the Ragbits 0.2 milestone Oct 10, 2024
@micpst micpst added the docs Improvements or additions to documentation label Oct 11, 2024
@ludwiktrammer ludwiktrammer linked a pull request Oct 15, 2024 that will close this issue
chore: Add project-level README #103
Merged
@github-project-automation github-project-automation bot moved this from In review to Done in ragbits Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ludwiktrammer ludwiktrammer

Labels
docs Improvements or additions to documentation
Projects
ragbits
Status: Done
Milestone
Ragbits 0.2
Development

Successfully merging a pull request may close this issue.

chore: Add project-level README deepsense-ai/ragbits
3 participants
@ludwiktrammer @mhordynski @micpst