Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Oct 1, 2023
1 parent d9a39de commit f542239
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles: :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk:

So, you want to contribute to this project! That's awesome. However, before
doing so, please read the following simple steps explaining how to contribute. This will
make life easier and help avoid wasting time on things that are not
doing so, please read the following simple steps how to contribute. This will
make the life easier and will avoid wasting time on things which are not
requested. :sparkles:

## Discuss the changes before doing them
Expand All @@ -15,9 +15,9 @@ requested. :sparkles:
system, Node.JS version etc.), screenshots (so we can see what you are
seeing).

- It is recommended to wait for feedback before continuing the next steps.
- It is recommended to wait for feedback before continuing to next steps.
However, if the issue is clear (e.g. a typo) and the fix is simple, you can
continue to fix it.
continue and fix it.

## Fixing issues
- Fork the project in your account and create a branch with your fix:
Expand Down
6 changes: 3 additions & 3 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Sets, gets or deletes the cookie.
- **String** `value`: If provided and it not `null`, the cookie will be set. If it's null, the cookie will be deleted. If `value` is not provided, the cookie value will be returned.

#### Return
- **String|null|undefined** `null`, if the cookie was deleted. `undefined` if the cookie doesn't exist. The cookie value if this exists.
- **String** `null`, if the cookie was deleted. `undefined` if the cookie doesn't exist. The cookie value if this exists.

### `file(path, customRoot)`
Serves a file to the response.
Expand Down Expand Up @@ -218,7 +218,7 @@ Gets the transformer for a url.
- **String** `method`: The method.

#### Return
- **Transformer|null** The transformer (if it exists) or `null`.
- **Transformer** The transformer (if it exists) or `null`.

### `getHooksStrict(type, url, method)`
Similar to `getHooks`, but doesn't concat hooks based on the regex
Expand All @@ -231,7 +231,7 @@ matching but only if they are the same regex.
- **String** `method`: The method.

#### Return
- **Transformer|null** The transformer (if it exists) or `null`.
- **Transformer** The transformer (if it exists) or `null`.

### `insertHook(type, url, method, trans)`
Inserts a new hook.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Sets, gets or deletes the cookie.
- **String** `value`: If provided and it not `null`, the cookie will be set. If it's null, the cookie will be deleted. If `value` is not provided, the cookie value will be returned.

#### Return
- **String|null|undefined** `null`, if the cookie was deleted. `undefined` if the cookie doesn't exist. The cookie value if this exists.
- **String** `null`, if the cookie was deleted. `undefined` if the cookie doesn't exist. The cookie value if this exists.

### `file(path, customRoot)`
Serves a file to the response.
Expand Down Expand Up @@ -352,7 +352,7 @@ Gets the transformer for a url.
- **String** `method`: The method.

#### Return
- **Transformer|null** The transformer (if it exists) or `null`.
- **Transformer** The transformer (if it exists) or `null`.

### `getHooksStrict(type, url, method)`
Similar to `getHooks`, but doesn't concat hooks based on the regex
Expand All @@ -365,7 +365,7 @@ matching but only if they are the same regex.
- **String** `method`: The method.

#### Return
- **Transformer|null** The transformer (if it exists) or `null`.
- **Transformer** The transformer (if it exists) or `null`.

### `insertHook(type, url, method, trans)`
Inserts a new hook.
Expand Down

0 comments on commit f542239

Please sign in to comment.