diff --git a/.r/banner.png b/.r/banner.png new file mode 100644 index 0000000..ac44967 Binary files /dev/null and b/.r/banner.png differ diff --git a/.r/logo.png b/.r/logo.png deleted file mode 100644 index 6531b65..0000000 Binary files a/.r/logo.png and /dev/null differ diff --git a/README.md b/README.md index a6097f5..42a4f88 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -
- +
+
@@ -7,14 +7,78 @@
+ Start now โจ +
+ + ## Features ๐ -- Pre-configured `microbundle` repository +- Pre-configured `microbundle` repository ๐ฆ +- Pre-configured `eslint` and `prettier` ๐ ๏ธ +- Pre-configured `jest` and `ts-jest` ๐งช ## Usage ๐ You can clone the repository or click on the `Use this template` button to create a new repository from this template. +Start hacking inside the `src` folder and run `npm run build` to build the package. + +## Publishing ๐ + +While we haven't included a specific package for publishing your NPM package, we do have a few recommendations for you. If you want a simple and straightforward method for publishing your package, **we recommend using the [np](https://github.com/sindresorhus/np) package.** +The following command will guide you through the publishing process, and it is an easy way to publish your package. + +```bash +npx np +``` + +## Configuration ๐ ๏ธ + +micro-ts is based on the `microbundle` package. You can find more information about the configuration [here](https://github.com/developit/microbundle). + +The `package.json` file contains the following keys: + +``` + +{ +"name": "foo", // your package name +"type": "module", +"source": "src/foo.js", // your source code +"exports": { +"require": "./dist/foo.cjs", // used for require() in Node 12+ +"default": "./dist/foo.modern.js" // where to generate the modern bundle (see below) +}, +"main": "./dist/foo.cjs", // where to generate the CommonJS bundle +"module": "./dist/foo.module.js", // where to generate the ESM bundle +"unpkg": "./dist/foo.umd.js", // where to generate the UMD bundle (also aliased as "umd:main") +"scripts": { +"build": "microbundle", // compiles "source" to "main"/"module"/"unpkg" +"dev": "microbundle watch" // re-build when source files change +} +} + +``` + +This is a copy of the `microbundle` documentation. + +When you build your project using `microbundle, three different file formats are generated: + +- .umd.js: A Universal Module Definition (UMD) file format that works in different module systems, including AMD, CommonJS, and global scripts. + +- .module.js: An ES module file format that uses the import and export syntax and is designed to work in modern browsers and build tools. + +- .cjs: A CommonJS module file format that uses the require and module.exports syntax and is used in Node.js and older JavaScript environments. + +You can use these file formats to **target different environments**. + ## License ๐ [MIT](./LICENSE) + + ++ Start now โจ +
+ diff --git a/package.json b/package.json index 9a8b951..2aa04d8 100644 --- a/package.json +++ b/package.json @@ -1,22 +1,22 @@ { "name": "micro-ts", - "type": "module", - "source": "src/index.ts", + "version": "1.1.1", + "repository": "https://github.com/adevinwild/micro-ts", + "author": "adevinwild", + "license": "MIT", "files": [ "dist" ], + "type": "module", + "source": "src/index.ts", "exports": { "require": "./dist/index.cjs", "default": "./dist/index.modern.js" }, - "version": "1.0.0", "description": "A micro minimalist template to publish TypeScript packages with `microbundle`", "main": "./dist/index.cjs", "module": "./dist/index.module.js", "unpkg": "./dist/index.umd.js", - "repository": "https://github.com/adevinwild/micro-ts", - "author": "adevinwild", - "license": "MIT", "scripts": { "build": "npm run clean && microbundle", "dev": "microbundle watch",