Skip to content

Commit 566c110

Browse files
authored
Update README.md (#2)
1 parent d964496 commit 566c110

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,44 @@
1-
# prisma-offset-pagination
1+
# Prisma Offset Pagination
22

3-
> Offset Pagination based on cursor system to enhance the paginating speed to the point of Cursor Pagination
3+
<div>
44

55
[![Npm Version](https://img.shields.io/badge/npm%20package-0.0.1-brightgreen)](https://npmjs.com/package/cursor-based-offset-pagination)
66
![License](https://img.shields.io/badge/license-MIT-blue)
77

8-
<br />
8+
</div>
9+
10+
Offset Pagination based on cursor system to enhance the paginating speed to the point of Cursor Pagination.
11+
12+
More explanation about the package, you can read the medium article [here](https://medium.com/@smallbee/super-fast-offset-pagination-with-prisma2-21db93e5cc90).
13+
14+
- [Installation](#installation)
15+
- [Usage](#usage)
16+
- [Use Module](#use-module)
17+
- [GraphQL Query](#graphql-query)
18+
- [Query Result](#query-result)
19+
- [Parameters](#parameters)
20+
- [Description](#description)
21+
- [Features](#features)
922

10-
# Installation
1123

12-
`npm`
24+
## Installation
25+
26+
### NPM
27+
1328
```
1429
npm install prisma-offset-pagination
1530
```
1631

17-
`yarn`
32+
### Yarn
33+
1834
```
19-
npm add prisma-offset-pagination
35+
yarn add prisma-offset-pagination
2036
```
2137

2238

23-
# Usage
39+
## Usage
2440

25-
### # use module
41+
### Use Module
2642
```typescript
2743
import { prismaOffsetPagination } from 'prisma-offset-pagination';
2844

@@ -42,7 +58,7 @@ const result = prismaOffsetPagination({
4258
});
4359
```
4460

45-
### # GraphQL Query
61+
### GraphQL Query
4662
```graphql
4763
query {
4864
users(
@@ -94,7 +110,7 @@ query {
94110
}
95111
```
96112

97-
### # Query Result
113+
### Query Result
98114
```graphql
99115
{
100116
"data": {
@@ -163,7 +179,7 @@ query {
163179
}
164180
```
165181

166-
### # Parameters
182+
### Parameters
167183

168184
`model` \
169185
: Receive model object that you want to implement pagination

0 commit comments

Comments
 (0)