Skip to content

Commit f6aaea0

Browse files
committed
Fixed readme
1 parent d948a6f commit f6aaea0

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

readme.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
You can send insert, update, delete, and fetch data from Axe API servers without pain. `axe-api-client` has advanced query support with the active record pattern.
2929

30-
## Config
30+
## ⚙️ Config
3131

3232
```ts
3333
import { api, IRequest } from "axe-api-client";
@@ -47,7 +47,7 @@ api.interceptors.addResponse((response: Response) => {
4747
});
4848
```
4949

50-
## Insert
50+
## Insert
5151

5252
```js
5353
const response = await api.resource("users").insert({
@@ -56,7 +56,7 @@ const response = await api.resource("users").insert({
5656
});
5757
```
5858

59-
## Post
59+
## 📤 Post
6060

6161
```js
6262
const response = await api.resource("users").post({
@@ -65,7 +65,7 @@ const response = await api.resource("users").post({
6565
});
6666
```
6767

68-
## Update
68+
## 🔄 Update
6969

7070
```js
7171
const response = await api.resource("users").update({
@@ -74,7 +74,7 @@ const response = await api.resource("users").update({
7474
});
7575
```
7676

77-
## Patch
77+
## 🩹 Patch
7878

7979
```js
8080
const response = await api.resource("users").patch({
@@ -83,7 +83,7 @@ const response = await api.resource("users").patch({
8383
});
8484
```
8585

86-
## Put
86+
## ✏️ Put
8787

8888
```js
8989
const response = await api.resource("users").put({
@@ -92,21 +92,21 @@ const response = await api.resource("users").put({
9292
});
9393
```
9494

95-
## Delete
95+
## 🗑️ Delete
9696

9797
```js
9898
const response = await api.resource("users").delete();
9999
```
100100

101-
## Query
101+
## 🔍 Query
102102

103103
```js
104104
import { api } from "axe-api-client";
105105

106106
const data = await api.resource("users").paginate();
107107
```
108108

109-
## Fields
109+
## 📝 Fields
110110

111111
```js
112112
const response = await api
@@ -115,7 +115,7 @@ const response = await api
115115
.paginate();
116116
```
117117

118-
## Sorting
118+
## 🧩 Sorting
119119

120120
```js
121121
const response = await api
@@ -127,19 +127,19 @@ const response = await api
127127
.paginate();
128128
```
129129

130-
## Limits
130+
## 🚦 Limits
131131

132132
```js
133133
const response = await api.resource("users").paginate({ page: 1, perPage: 25 });
134134
```
135135

136-
## First
136+
## First
137137

138138
```js
139139
const response = await api.resource("users").first();
140140
```
141141

142-
## Where Conditions
142+
## Where Conditions
143143

144144
```js
145145
const response = await api.resource("users").where("age", 18).paginate();
@@ -188,7 +188,7 @@ const response = await api
188188

189189
> All the [operators](https://axe-api.com/basics/queries/index.html#operators) should be able to used.
190190
191-
## Related Data
191+
## 🔗 Related Data
192192

193193
```js
194194
const response = await api
@@ -197,7 +197,7 @@ const response = await api
197197
.paginate();
198198
```
199199

200-
## Quick where functions
200+
## Quick where functions
201201

202202
We can use the following query where functions:
203203

@@ -211,6 +211,14 @@ We can use the following query where functions:
211211
- `whereNull("age")`
212212
- `whereNotNull("age")`
213213

214-
## License
214+
## 👥 Contributors
215+
216+
<a href="https://github.com/axe-api/client/graphs/contributors">
217+
<img src="https://contrib.rocks/image?repo=axe-api/client" />
218+
</a>
219+
220+
Made with [contrib.rocks](https://contrib.rocks).
221+
222+
## 📜 License
215223

216224
[MIT License](LICENSE)

0 commit comments

Comments
 (0)