Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
utdemir committed Jun 18, 2023
1 parent 3bd28a5 commit 5889756
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build_and_test.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test Action
name: Test

on:
- push
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish_docs.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish documentation on main
name: Publish Docs

on:
push:
Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# composable-indexes

Index arbitrary JavaScript objects with multiple dimensions. Build on top of included BTree and Hash indexes and combinators, or extend the library with your own index.
Index arbitrary JavaScript objects with multiple dimensions. Build on top of included indexes and combinators, or extend the library with your own index.

## Features

* **TypeScript** - Written in TypeScript, with full IDE & typechecker support.
* **Composable** - Build complex indexes from simple ones with combinators.
* **Built-in indexes** - Comes with built-in indexes backed by performant data structures.
* **Aggregations** - Maintain aggregate values from the collections.
* **Extensible** - Write your own index and aggregations.

## See Also

* **In-memory databases**
* [**Dexie.js**](https://dexie.org): A Minimalistic Wrapper for IndexedDB
* [**LokiJS**](https://github.com/techfort/LokiJS): Javascript embeddable / in-memory database
* [**Dexie.js**](https://dexie.org): A Minimalistic Wrapper for IndexedDB
* [**LokiJS**](https://github.com/techfort/LokiJS): Javascript embeddable / in-memory database
* [**multi-index**](https://github.com/arielshaqed/multi-index): A container with multiple indexes

0 comments on commit 5889756

Please sign in to comment.