Skip to content

Commit b156264

Browse files
committed
chore: improve readme
chore: wip
1 parent 03d57bb commit b156264

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
bun install -d @stacksjs/dtsx
2020
```
2121

22-
_@npm.js, please allow us to use the `dtsx` package name 🙏_,
22+
_@npmjs.com, please allow us to use the `dtsx` package name 🙏_
2323

2424
<!-- _Alternatively, you can install:_
2525
@@ -32,11 +32,11 @@ pkgx install dtsx # wip
3232

3333
There are two ways of using this ".d.ts generation" tool: _as a library or as a CLI._
3434

35-
### Library
35+
## Library
3636

3737
Given the npm package is installed, you can use the `generate` function to generate TypeScript declaration files from your project.
3838

39-
#### Usage
39+
### Usage
4040

4141
```ts
4242
import { generate } from '@stacksjs/dtsx'
@@ -56,10 +56,11 @@ await generate(options?: Options)
5656

5757
_Available options:_
5858

59-
The library can configured using a `dts.config.ts` _(or `dts.config.js`)_ file and it will be automatically loaded when running the `./dtsx` _(or `bunx dtsx`)_ command.
59+
Library usage can also be configured using a `dts.config.ts` _(or `dts.config.js`)_ file which is automatically loaded when running the `./dtsx` _(or `bunx dtsx`)_ command. It is also loaded when the `generate` function is called, unless custom options are provided.
6060

6161
```ts
6262
// dts.config.ts (or dts.config.js)
63+
6364
export default {
6465
cwd: './',
6566
root: './src',
@@ -70,20 +71,20 @@ export default {
7071
}
7172
```
7273

73-
_Then run:_
74+
_You may also run:_
7475

7576
```bash
7677
./dtsx generate
7778

78-
# or, you may use
79+
# if the package is installed, you can also run:
7980
# bunx dtsx generate
8081
```
8182

82-
### CLI
83+
## CLI
8384

8485
The `dtsx` CLI provides a simple way to generate TypeScript declaration files from your project. Here's how to use it:
8586

86-
#### Usage
87+
### Usage
8788

8889
Generate declaration files using the default options:
8990

0 commit comments

Comments
 (0)