Skip to content

Commit 116599f

Browse files
committed
docs: updates
1 parent 854df66 commit 116599f

File tree

2 files changed

+10
-17
lines changed

2 files changed

+10
-17
lines changed

README.md

+9-16
Original file line numberDiff line numberDiff line change
@@ -114,41 +114,34 @@ const middleware = defineI18nMiddleware({
114114
### Utilities
115115

116116
`@intlify/h3` composable utilities accept event (from
117-
`eventHandler((event) => {})`) as their first argument. (Exclud
118-
`useTranslation`) return the
119-
[`Intl.Locale`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale)
117+
`eventHandler((event) => {})`) as their first argument. (Exclud `useTranslation`) return the [`Intl.Locale`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale)
120118

121119
### Translations
122120

123121
- `useTranslation(event)`: use translation function
124122

125123
### Headers
126124

127-
- `getHeaderLocale(event)`: get locale from `accept-language` header
128-
- `getHeaderLocales(event)`: get some locales from `accept-language` header
125+
- `getHeaderLocale(event, options)`: get locale from `accept-language` header
126+
- `getHeaderLocales(event, options)`: get some locales from `accept-language` header
129127

130128
### Cookies
131129

132-
- `getCookieLocale()`: get locale from cookie
133-
- `setCookieLocale()`: set locale to cookie
130+
- `getCookieLocale(event, options)`: get locale from cookie
131+
- `setCookieLocale(event, options)`: set locale to cookie
134132

135133
### Misc
136134

137-
- `getPathLocale(event)`: get locale from path
138-
- `getQueryLocale(event)`: get locale from query
135+
- `getPathLocale(event, options)`: get locale from path
136+
- `getQueryLocale(event, options)`: get locale from query
139137

140138
## Helpers
141139

142-
- `detectLocaleFromAcceptLanguageHeader`: detect locale from `accept-language`
143-
header
140+
- `detectLocaleFromAcceptLanguageHeader(event)`: detect locale from `accept-language` header
144141

145142
## 🙌 Contributing guidelines
146143

147-
If you are interested in contributing to `@intlify/h3`, I highly recommend
148-
checking out [the contributing guidelines](/CONTRIBUTING.md) here. You'll find
149-
all the relevant information such as
150-
[how to make a PR](/CONTRIBUTING.md#pull-request-guidelines),
151-
[how to setup development](/CONTRIBUTING.md#development-setup)) etc., there.
144+
If you are interested in contributing to `@intlify/h3`, I highly recommend checking out [the contributing guidelines](/CONTRIBUTING.md) here. You'll find all the relevant information such as [how to make a PR](/CONTRIBUTING.md#pull-request-guidelines), [how to setup development](/CONTRIBUTING.md#development-setup)) etc., there.
152145

153146
## ©️ License
154147

deno.jsonc

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"include": [
99
],
1010
*/
11-
"exclude": ["node_modules", "dist"]
11+
"exclude": ["node_modules", "dist", "README.md"]
1212
},
1313
"semiColons": false,
1414
"singleQuote": true

0 commit comments

Comments
 (0)