Skip to content

Commit

Permalink
chore: Add documentation for main export
Browse files Browse the repository at this point in the history
Should fix the jsr score.
  • Loading branch information
donovanglover committed Apr 20, 2024
1 parent c7da853 commit d9cf84e
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/lib.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@ import { Base16Config } from './Base16Config.ts'
import type { Base16Options } from './Base16Options.ts'
import { Base16Plugin } from './Base16Plugin.ts'

/** Usage:
*
* ```ts
* import { base16Tailwind } from '@donovanglover/base16-tailwind'
* ```
*
* @param options The options to customize base16-tailwind with.
*/
export const base16Tailwind: {
(options?: Base16Options): {
handler: PluginCreator,
handler: PluginCreator
config?: Partial<Config>
}

Expand Down

0 comments on commit d9cf84e

Please sign in to comment.