Skip to content

Commit

Permalink
Merge pull request #8 from forge42dev/readme-update
Browse files Browse the repository at this point in the history
README update
  • Loading branch information
AlemTuzlak authored Nov 11, 2024
2 parents 6fe582b + 81811fb commit 3b1804a
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 24 deletions.
20 changes: 10 additions & 10 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.0.2/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": true,
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
"$schema": "https://unpkg.com/@changesets/config@3.0.2/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": true,
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
![GitHub Repo stars](https://img.shields.io/github/stars/forge42dev/open-source-stack?style=social)
![npm](https://img.shields.io/npm/v/open-source-stack?style=plastic)
![GitHub](https://img.shields.io/github/license/forge42dev/open-source-stack?style=plastic)
![npm](https://img.shields.io/npm/dy/open-source-stack?style=plastic)
![npm](https://img.shields.io/npm/dw/open-source-stack?style=plastic)
![GitHub top language](https://img.shields.io/github/languages/top/forge42dev/open-source-stack?style=plastic)
![npm](https://img.shields.io/npm/dy/open-source-stack?style=plastic)
![npm](https://img.shields.io/npm/dw/open-source-stack?style=plastic)
![GitHub top language](https://img.shields.io/github/languages/top/forge42dev/open-source-stack?style=plastic)

Full starter stack to develop CJS/ESM compatible npm packages with TypeScript, Vitest, ESLint, Prettier, and GitHub Actions.

Expand All @@ -21,8 +21,7 @@ Build your own open-source project today! 🚀

- **TypeScript**: TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
- **Vitest**: A modern test runner built on top of Vite.
- **ESLint**: ESLint statically analyzes your code to quickly find problems.
- **Prettier**: Prettier is an opinionated code formatter.
- **Biome**: Biome statically analyzes your code to find issues and formats your code with a consistent, opinionated style.
- **GitHub Actions**: Automate your workflow from idea to production.
- **tsup** - Zero-config bundler for tiny TypeScript libraries.

Expand Down Expand Up @@ -54,4 +53,3 @@ Build your own open-source project today! 🚀
- `npm run lint` - Lint the code.
- `npm run dev` - Start the package and ESM test app in watch mode for development.
- `npm run dev:cjs` - Start the package and CJS test app in watch mode for development.

11 changes: 3 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,8 @@
"bugs": {
"url": "https://github.com/forge42dev/open-source-stack/issues"
},
"files": [
"dist"
],
"workspaces": [
".",
"test-apps/*"
],
"files": ["dist"],
"workspaces": [".", "test-apps/*"],
"homepage": "https://github.com/forge42dev/open-source-stack#readme",
"devDependencies": {
"@arethetypeswrong/cli": "^0.15.4",
Expand Down Expand Up @@ -83,4 +78,4 @@
"engines": {
"node": ">=20.0.0"
}
}
}

0 comments on commit 3b1804a

Please sign in to comment.