Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Hoisted Docs + Demo to top, small content changes
  • Loading branch information
travismfrank authored Sep 24, 2020
1 parent 05d15f3 commit 3962f07
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@

Obsidian is Deno's first native GraphQL caching client and server module. Boasting lightning-fast caching and fetching capabilities alongside headlining normalization and destructuring strategies, obsidian is equipped to support scalable, highly performant applications.

Optimized for use in server-side rendered React apps built with Deno, fullstack integration of obsidian enables many of its most powerful features, including optimized caching exchanges between client and server as well as server-side user session storage, maintaining the benefits of server-side rendering even after client-side caches have expired.
Optimized for use in server-side rendered React apps built with Deno, full stack integration of obsidian enables many of its most powerful features, including optimized caching exchanges between client and server and extremely lightweight client-side caching.

## Documentation and Demo

[obsidian.land](http://obsidian.land)

## Installation

Expand Down Expand Up @@ -66,9 +70,7 @@ const types = (gql as any)`
`;

const resolvers = {
Query: {
// Resolvers
}
// Resolvers
}

interface ObsRouter extends Router {
Expand All @@ -79,6 +81,7 @@ const GraphQLRouter = await ObsidianRouter<ObsRouter>({
Router,
typeDefs: types,
resolvers: resolvers,
redisPort: 6379,
});

app.use(GraphQLRouter.routes(), GraphQLRouter.allowedMethods());
Expand Down Expand Up @@ -141,13 +144,12 @@ const App = () => {

## Making a Query


```javascript
import { useObsidian } from 'https://deno.land/x/[email protected]/mod.ts';

const WeatherApp = () => {
const { gather } = useObsidian();
const [weather, setWeather] = useState('Sunny');
const [weather, setWeather] = (React as any).useState('Sunny');

return (
<h1>{weather}</h1>
Expand All @@ -159,14 +161,8 @@ const WeatherApp = () => {
>Get Weather</button>
);
};

```

## Documentation and Demo

[obsidian.land](http://obsidian.land)


## Authors

*Lascaux* Engineers
Expand Down

0 comments on commit 3962f07

Please sign in to comment.