Skip to content

Commit

Permalink
Fixed wrong description in the documentation section
Browse files Browse the repository at this point in the history
  • Loading branch information
3adel-bassiony committed Jan 23, 2024
1 parent c76c7e3 commit b8c4b50
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,13 +149,13 @@ The Fetchly package comes with a comprehensive set of features designed to make

- ### Request Methods

- **GET**: You can localize a message using one of those methods
- **GET**: Use this method to make a GET request to retrieve the data from a server

```typescript
const { data, error } = await fetchly.get('/products')
```

- **POST**: You can localize a message using one of those methods
- **POST**: Use this method to make a POST request to submit the data

```typescript
const body = {
Expand All @@ -165,7 +165,7 @@ The Fetchly package comes with a comprehensive set of features designed to make
const { data, error } = await fetchly.post('/products', body)
```

- **PUT**: Use this method to change the current locale of Fetchly
- **PUT**: Use this method to make a PUT request to submit the data

```typescript
const body = {
Expand All @@ -175,15 +175,15 @@ The Fetchly package comes with a comprehensive set of features designed to make
const { data, error } = await fetchly.put('/products/1', body)
```

- **DELETE**: Use this method to check if the current locale is what you looking for or not.
- **DELETE**: Use this method to make a DELETE request

```typescript
const { data, error } = await fetchly.delete('/products/1')
```

- ### Other Methods

- **configure**: Use this method to check if the current locale is what you looking for or not.
- **configure**: You can configure the Fetchly instance using this method, you will find all available options below:

```typescript
fetchly.configure({
Expand All @@ -194,7 +194,7 @@ The Fetchly package comes with a comprehensive set of features designed to make
})
```

- **convertSearchParamsToString** Check if a specific identifier exists in the localization object or not
- **convertSearchParamsToString** A helper function that converts an object to a string so you can append it to the URL

```typescript
const searchParams = {
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fetchly",
"version": "1.0.0",
"version": "1.0.1",
"description": "A lightweight and simple package for making requests using fetch",
"main": "build/index.js",
"types": "build/index.d.ts",
Expand Down

0 comments on commit b8c4b50

Please sign in to comment.