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

Update README.md #80

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 OSLabs Beta
Copyright (c) 2024 OSLabs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
<div align="center">

<h1 align="center">
<a>Obsidian</a>
<a href="https://twitter.com/intent/tweet?text=Meet%20Obsidian!%20Deno's%20first%20native%20GraphQL%20caching%20client%20and%20server%20module&url=http://obsidian.land/&via=obsidian_land&hashtags=deno,denoland,nodejs,graphql,javascript" rel="nofollow"><img src="https://camo.githubusercontent.com/83d4084f7b71558e33b08844da5c773a8657e271/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f75726c2f687474702f736869656c64732e696f2e7376673f7374796c653d736f6369616c" alt="Tweet" data-canonical-src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social" style="max-width:100%;"></a>
<a href="https://deno.land/x/obsidian">Obsidian</a>
</h1>

</div>
Expand All @@ -18,13 +17,17 @@
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/open-source-labs/obsidian?style=social">
</p>

## Features
## New in v8.0.0

- (New!) Support for W-TinyLFU client-side cache that brings great hit-ratio performance with minimal memory overhead
- (New!) Option to provide Obsidian with the search types your application uses, allowing data cached from complete dataset pulls to be accessible later on in searches for individual items
- (New!) Refactored server-side caching with Redis
- (New!) Rebuilt developer tool for Obsidian 8.0 for testing and analytics related to the new client caching options
- (New!) Option for persistent queries, allowing only a smaller hash to be sent to the server on client-side cache misses, minimizing the cost of queries. Note that while this will increase the overall performance for frequent, repeat queries.
- Support for W-TinyLFU client-side cache that brings great hit-ratio performance with minimal memory overhead
- Option to provide Obsidian with the search types your application uses, allowing data cached from complete dataset pulls to be accessible later on in searches for individual items
- Refactored server-side caching with Redis
- Rebuilt developer tool for Obsidian 8.0 for testing and analytics related to the new client caching options
- Option for persistent queries, allowing only a smaller hash to be sent to the server on client-side cache misses, minimizing the cost of queries. Note that while this will increase the overall performance for frequent, repeat queries.

Find more details in our <a href="https://medium.com/@davidmnorman/obsidian-8-0-8b45a3b84668"> Medium</a> article!

## Features
- Flexible cache responds only with data requested from selected fields
- GraphQL query abstraction and caching improving the performance of your app
- SSR React wrapper, allowing you to cache in browser
Expand Down Expand Up @@ -196,7 +199,7 @@ Be sure to also specify the Redis TCP port by passing in the port number as an a

## Documentation

[getobsidian.io](http://getobsidian.io/)
Work in Progress!

## Developer Tool

Expand Down
3 changes: 3 additions & 0 deletions src/Browser/HillClimbing.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
//https://github.com/ben-manes/caffeine/wiki/Efficiency
//https://github.com/ben-manes/caffeine/wiki/Efficiency
//Reference for implementaing Hill Climber Optimization in future iterations