Skip to content

Commit

Permalink
chore: add status to README [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
angeloashmore committed May 12, 2021
1 parent a384c8f commit 865362e
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,19 @@ The official JavaScript + TypeScript client library for [Prismic][prismic].
```typescript
import * as prismic from '@prismicio/client'

// First, create a client
// Create a client
const endpoint = prismic.getEndpoint('my-repository')
const client = prismic.createClient(endpoint)

// Then query for your content
const response = await client.getAllByType('blog_post')
```

## Status

[![npm version](https://img.shields.io/npm/v/@prismicio/client?style=flat-square)](https://www.npmjs.com/package/@prismicio/client)
[![Build Status](https://img.shields.io/github/workflow/status/prismicio/prismic-javascript/Tests?style=flat-square)](https://github.com/prismicio/prismic-javascript/actions?query=workflow%3ATests)

## Install

```sh
Expand All @@ -26,15 +31,15 @@ npm install @prismicio/client

## Documentation

For full documentation, visit the [Prismic documentation site][docs].
For full documentation, visit the [Prismic documentation site][prismic-docs].

## Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd
love to have you as part of the Prismic developer community!

**Reporting a bug**: [Open an issue][repo-issues] explaining your site's setup
and the bug you're encountering.
**Reporting a bug**: [Open an issue][repo-issues] explaining your application's
setup and the bug you're encountering.

**Suggest an improvement**: [Open an issue][repo-issues] explaining your
improvement or feature so we can discuss and learn more.
Expand All @@ -48,6 +53,6 @@ changes should be implemented.
[prismic-predicates]:
https://prismic.io/docs/technologies/query-predicate-reference-javascript
[prismic-previews]: https://prismic.io/docs/core-concepts/previews
[docs]: https://prismic.io/docs/technologies/javascript
[prismic-docs]: https://prismic.io/docs/technologies/javascript
[repo-issues]: https://github.com/prismicio/prismic-javascript/issues
[repo-pull-requests]: https://github.com/prismicio/prismic-javascript/pulls

0 comments on commit 865362e

Please sign in to comment.