Skip to content

Commit

Permalink
Add footnotes about the FSD root
Browse files Browse the repository at this point in the history
  • Loading branch information
illright committed Dec 3, 2023
1 parent b82d71d commit 05a67d8
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ If you have at least one slice in your project already, the CLI will know where
fsd feat employee/employee-record
```

In a detected FSD root or current folder, produces:
In a detected FSD root[^1] or current folder, produces:

- `features/employee/employee-record/index.(js|ts)` (depending on your project)

Expand All @@ -73,7 +73,7 @@ If you have at least one slice in your project already, the CLI will know where
fsd page edit-note, note-list -s ui api
```

In a detected FSD root or current folder, produces:
In a detected FSD root[^1] or current folder, produces:

- `pages/edit-note/index.(js|ts)` (depending on your project)
- `pages/edit-note/ui/`
Expand All @@ -90,7 +90,7 @@ If you have at least one slice in your project already, the CLI will know where
fsd shared ui -s api
```

In a detected FSD root or current folder, produces:
In a detected FSD root[^1] or current folder, produces:

- `shared/ui/index.(js|ts)`
- `shared/api/index.(js|ts)`
Expand All @@ -104,3 +104,5 @@ Big thanks to a community member [`Agent_RBY_`](https://github.com/AgentRBY) for
## License

The source code of this project is distributed under the terms of the ISC license. It's like MIT, but better. [Click here](https://choosealicense.com/licenses/isc/) to learn what that means.
[^1]: An FSD root is the folder that contains slices in Feature-Sliced Design. There can be several independent roots in one project.

0 comments on commit 05a67d8

Please sign in to comment.