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.

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

docs: adds new readme #815

Merged
merged 4 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
345 changes: 71 additions & 274 deletions README.md

Large diffs are not rendered by default.

Binary file added misc/readme/features-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added misc/readme/features-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed misc/readme/orama-readme-dark.png
Binary file not shown.
Binary file added misc/readme/orama-readme-hero-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added misc/readme/orama-readme-hero-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed misc/readme/orama-readme-light.png
Binary file not shown.
Binary file removed misc/readme/orama-readme-runtime-dark.png
Binary file not shown.
Binary file removed misc/readme/orama-readme-runtime-light.png
Binary file not shown.
Binary file removed misc/readme/orama-readme_logo-dark.png
Binary file not shown.
Binary file removed misc/readme/orama-readme_logo-light.png
Binary file not shown.
Binary file removed misc/readme/orama-readme_runs-dark.png
Binary file not shown.
Binary file removed misc/readme/orama-readme_runs-light.png
Binary file not shown.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "orama-monorepo",
"version": "3.0.0-rc-3",
"description": "Next generation full-text and vector search engine, written in TypeScript",
"description": "A complete RAG pipeline in your browser, server, or edge network with support for full-text, vector, and hybrid search in less than 2kb.",
"workspaces": [
"packages/*",
"sandboxes/*"
Expand Down Expand Up @@ -44,14 +44,14 @@
},
"author": {
"name": "Michele Riva",
"email": "michele.riva@oramasearch.com",
"email": "michele@orama.com",
"url": "https://github.com/MicheleRiva",
"author": true
},
"contributors": [
{
"name": "Tommaso Allevi",
"email": "tommaso.allevi@oramasearch.com",
"email": "tommaso.allevi@orama.com",
"url": "https://github.com/allevo",
"author": true
}
Expand Down
6 changes: 3 additions & 3 deletions packages/orama/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@orama/orama",
"version": "3.0.0-rc-3",
"type": "module",
"description": "Next generation full-text and vector search engine, written in TypeScript",
"description": "A complete RAG pipeline in your browser, server, or edge network with support for full-text, vector, and hybrid search in less than 2kb.",
"sideEffects": false,
"main": "./dist/commonjs/index.js",
"exports": {
Expand Down Expand Up @@ -116,14 +116,14 @@
],
"author": {
"name": "Michele Riva",
"email": "michele.riva@oramasearch.com",
"email": "michele.riva@orama.com",
"url": "https://github.com/MicheleRiva",
"author": true
},
"contributors": [
{
"name": "Tommaso Allevi",
"email": "tommaso.allevi@oramasearch.com",
"email": "tommaso.allevi@orama.com",
"url": "https://github.com/allevo"
},
{
Expand Down
3 changes: 0 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading