readme

Author: pyramation

README.md

@@ -13,8 +13,79 @@
    <a href="https://www.npmjs.com/package/@interweb/build"><img height="20" src="https://img.shields.io/github/package-json/v/cosmology-tech/interweb-build?filename=packages%2Fbuild%2Fpackage.json"></a>
 </p>
 
-## install
+Interweb Build is a powerful wrapper around esbuild, designed to simplify and streamline your build process for Interweb projects.
+
+
+## Features
+
+- Simple API for building TypeScript projects
+- Customizable build options
+- Built-in support for common Interweb project configurations
+- Easy integration with existing projects
+
+
+## Installation
 
 ```sh
 npm install @interweb/build
 ```
+
+## Usage
+
+Here's a basic example of how to use Interweb Build:
+
+```js
+import { InterwebBuild, defaultOptions } from '@interweb/build';
+
+// Use default options
+InterwebBuild.build();
+
+// Customize options
+InterwebBuild.build({
+  entryPoints: ['src/custom-entry.ts'],
+  outfile: 'dist/custom-bundle.js',
+  minify: true,
+});
+
+// Use default options as a base for a custom configuration
+const myConfig = {
+  ...defaultOptions,
+  minify: true,
+  target: 'es2018',
+};
+InterwebBuild.build(myConfig);
+```
+
+## API Reference
+
+### `InterwebBuild.build(options)`
+
+Builds your project using the provided options.
+
+- `options` (optional): An object containing build options. If not provided, default options will be used.
+
+Returns a Promise that resolves to the build result.
+
+### `defaultOptions`
+
+An object containing the default build options. You can spread these into your own configuration for easy customization.
+
+## Default Configuration
+
+Interweb Build comes with the following default configuration:
+
+```ts
+{
+  bundle: true,
+  minify: false,
+  outfile: 'dist/bundle.js',
+  platform: 'node',
+  sourcemap: true,
+  target: 'ESNext',
+  logLevel: 'info',
+}
+```
+
+## License
+
+Interweb Build is MIT licensed.

packages/build/README.md

@@ -13,8 +13,79 @@
    <a href="https://www.npmjs.com/package/@interweb/build"><img height="20" src="https://img.shields.io/github/package-json/v/cosmology-tech/interweb-build?filename=packages%2Fbuild%2Fpackage.json"></a>
 </p>
 
-## install
+Interweb Build is a powerful wrapper around esbuild, designed to simplify and streamline your build process for Interweb projects.
+
+
+## Features
+
+- Simple API for building TypeScript projects
+- Customizable build options
+- Built-in support for common Interweb project configurations
+- Easy integration with existing projects
+
+
+## Installation
 
 ```sh
 npm install @interweb/build
 ```
+
+## Usage
+
+Here's a basic example of how to use Interweb Build:
+
+```js
+import { InterwebBuild, defaultOptions } from '@interweb/build';
+
+// Use default options
+InterwebBuild.build();
+
+// Customize options
+InterwebBuild.build({
+  entryPoints: ['src/custom-entry.ts'],
+  outfile: 'dist/custom-bundle.js',
+  minify: true,
+});
+
+// Use default options as a base for a custom configuration
+const myConfig = {
+  ...defaultOptions,
+  minify: true,
+  target: 'es2018',
+};
+InterwebBuild.build(myConfig);
+```
+
+## API Reference
+
+### `InterwebBuild.build(options)`
+
+Builds your project using the provided options.
+
+- `options` (optional): An object containing build options. If not provided, default options will be used.
+
+Returns a Promise that resolves to the build result.
+
+### `defaultOptions`
+
+An object containing the default build options. You can spread these into your own configuration for easy customization.
+
+## Default Configuration
+
+Interweb Build comes with the following default configuration:
+
+```ts
+{
+  bundle: true,
+  minify: false,
+  outfile: 'dist/bundle.js',
+  platform: 'node',
+  sourcemap: true,
+  target: 'ESNext',
+  logLevel: 'info',
+}
+```
+
+## License
+
+Interweb Build is MIT licensed.