Skip to content

Commit 927efee

Browse files
committed
readmes
1 parent 702bb62 commit 927efee

File tree

9 files changed

+658
-151
lines changed

9 files changed

+658
-151
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,31 @@ pnpm test
238238
pnpm lint
239239
```
240240

241+
## Development
242+
243+
### Setup
244+
245+
1. Clone the repository:
246+
247+
```bash
248+
git clone https://github.com/hyperweb-io/dev-utils.git
249+
```
250+
251+
2. Install dependencies:
252+
253+
```bash
254+
cd dev-utils
255+
pnpm install
256+
pnpm build
257+
```
258+
259+
3. Test the package of interest:
260+
261+
```bash
262+
cd packages/<packagename>
263+
pnpm test:watch
264+
```
265+
241266
## Disclaimer
242267

243268
AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

packages/appstash/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -242,12 +242,4 @@ console.log(dirs.config); // /opt/myapp/.myapp/config
242242
- **Clean**: No pollution of exports, minimal API surface
243243
- **Graceful**: Never throws, always returns valid paths
244244
- **Fallback**: XDG only as absolute fallback, not primary
245-
- **Focused**: Just directory resolution, no state management
246-
247-
## License
248-
249-
MIT
250-
251-
## Contributing
252-
253-
See the main [hyperweb-io/dev-utils repository](https://github.com/hyperweb-io/dev-utils) for contribution guidelines.
245+
- **Focused**: Just directory resolution, no state management

packages/create-gen-app/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,4 @@ Examples of valid variables:
145145
- `__author__`
146146
- `__CamelCase__`
147147
- `__snake_case__`
148-
- `__VERSION_1__`
149-
150-
## License
151-
152-
MIT
148+
- `__VERSION_1__`

packages/find-pkg/README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,4 @@ import { findPackageJson } from '@interweb-utils/find-pkg';
2929
const packageJson = findPackageJson();
3030
console.log('Package name:', packageJson.name);
3131
console.log('Version:', packageJson.version);
32-
```
33-
34-
## Developing
35-
36-
When first cloning the repo:
37-
38-
```
39-
yarn
40-
yarn build
41-
```
32+
```

0 commit comments

Comments
 (0)