Skip to content

Commit

Permalink
Update README with new branding and urql-docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
kitten committed Jun 6, 2019
1 parent ae18e5a commit 03c8e88
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
</a>
<br />
<br />
</div>

<img width="965" alt="Steve Urkel" src="https://user-images.githubusercontent.com/1457604/52959744-ee6cef80-338e-11e9-96fe-cf5231b8eab7.png">
<img width="640" alt="urql" src="https://raw.githubusercontent.com/FormidableLabs/urql/docs/ssr/docs/urql-banner.gif" />
</div>

## ✨ Features

Expand All @@ -35,15 +35,17 @@

While GraphQL is an elegant protocol and schema language, client libraries today typically come with large API footprints. We aim to create something more lightweight instead.

## [Documentation](docs/README.md)
## [Documentation](https://formidable.com/open-source/urql/docs)

[The documentation contains everything you need to know about `urql`](https://formidable.com/open-source/urql/docs)

[The documentation contains everything you need to know about `urql`](docs/README.md)
- [Getting Started guide](https://formidable.com/open-source/urql/docs/getting-started/)
- [Architecture](https://formidable.com/open-source/urql/docs/architecture/)
- [Basics](https://formidable.com/open-source/urql/docs/basics/)
- [Extending & Experimenting](https://formidable.com/open-source/urql/docs/extending-&-experimenting/)
- [API](https://formidable.com/open-source/urql/docs/api/)

- [Getting Started guide](docs/getting-started.md)
- [Architecture](docs/architecture.md)
- [Basics](docs/basics.md)
- [Extending & Experimenting](docs/extending-and-experimenting.md)
- [API](docs/api.md)
_You can find the raw markdown files inside this repository's `docs` folder._

## Quick Start Guide

Expand Down Expand Up @@ -95,7 +97,7 @@ const YourComponent = () => {
};
```

[Learn the full API in the "Getting Started" docs!](docs/getting-started.md)
[Learn the full API in the "Getting Started" docs!](https://formidable.com/open-source/urql/docs/getting-started/)

## Examples

Expand Down
Binary file added docs/urql-banner.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 03c8e88

Please sign in to comment.