Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Domi04151309 committed Jul 14, 2024
1 parent 57330d8 commit fd7725d
Showing 1 changed file with 39 additions and 3 deletions.
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
# Build

## Usage

To install the package, run the following command in your terminal:

```bash
npm install --dev github:anvil-solutions/build
```

To use the package in your project, you can follow the example below:

```javascript
import { build } from 'build';

const ROOT_DIRECTORY = 'public';

await build({
directories: [ROOT_DIRECTORY],
ignoreList: [
'.d.ts',
'.git',
'.test.js'
],
outDirectory: 'out',
rootDirectory: ROOT_DIRECTORY
});
```

## Development

Make sure you have npm (Node Package Manager) and Node.js installed on
your system before running this command. Additionally, run `npm install` in
the project's root directory to install all required dependencies.
Run `npm install` in the project's root directory to install all required
dependencies. Additionally, make sure you have npm (Node Package Manager) and
Node.js installed on your system before running this command.

## Linting

Expand All @@ -25,3 +52,12 @@ and TypeScript:
npm run eslint
npm run tsc
```

## Testing

To ensure your code is functioning correctly and to catch any potential issues
early, you can use the following command to run tests using Vitest:

```bash
npm run test
```

0 comments on commit fd7725d

Please sign in to comment.