Skip to content

Commit c5f7293

Browse files
authored
Merge pull request #17 from oslabs-beta/readme
Readme Fixes
2 parents 0fb9658 + d92b195 commit c5f7293

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
<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>
1010
</h1>
1111

12-
<p align="center">from <em align="center">Lascaux</em></p>
13-
1412
</div>
1513

1614
<p align="center">
@@ -26,8 +24,8 @@
2624
- (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
2725
- (New!) Refactored server-side caching with Redis
2826
- (New!) Rebuilt developer tool for Obsidian 8.0 for testing and analytics related to the new client caching options
29-
- (New!) Option for persistant 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 performance for frequent, repeat queries, you may see a performance drop for new queries that haven't yet been persisted
30-
- Flexible cache responds with only data requested from selected fields
27+
- (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.
28+
- Flexible cache responds only with data requested from selected fields
3129
- GraphQL query abstraction and caching improving the performance of your app
3230
- SSR React wrapper, allowing you to cache in browser
3331
- Configurable caching options, giving you complete control over your cache
@@ -63,12 +61,12 @@ const GraphQLRouter =
6361
(await ObsidianRouter) <
6462
ObsRouter >
6563
{
66-
Router,
64+
Router, // your router in deno
6765
typeDefs: types, // graphQL typeDefs
6866
resolvers: resolvers, // graphQL resolvers
6967
};
7068

71-
// attach the graphql routers routes to our app
69+
// attach the graphql router's routes to your deno app
7270
app.use(GraphQLRouter.routes(), GraphQLRouter.allowedMethods());
7371
```
7472
## Selecting options for the Router
@@ -86,8 +84,8 @@ const GraphQLRouter =
8684
redisPort: 6379, // Desired redis port, default to 6379
8785
policy: 'allkeys-lru', // Option select your Redis policy, default to allkeys-lru
8886
maxmemory = '2000mb', // Option to select Redis capacity, default to 2000mb
89-
searchTerms: [] //Optional array to allow board queries to store according to search fields so individual searches are found in cache
90-
persistQueries: true, //Boolean to toggle the use of persistant queries, default to false
87+
searchTerms: [] //Optional array to allow broad queries to store according to search fields so individual searches are found in cache
88+
persistQueries: true, //Boolean to toggle the use of persistent queries, default to false - NOTE: if using, must also be enabled in client wrapper
9189
hashTableSize = 16, // Size of hash table for persistent queries, default to 16
9290
maxQueryDepth = 0, // Maximum depth of query, default to 0
9391
customIdentifier: ['__typename', '_id'], // keys to be used to idedntify and normalize object

0 commit comments

Comments
 (0)