Skip to content

Commit 6387a6c

Browse files
ioncakephperioncakephper
committed
docs: update README.md
1 parent 5ea224e commit 6387a6c

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

‎README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ This template provides a solid foundation for any new JavaScript project, ensuri
2727
- [Contributing](#contributing)
2828
- [License](#license)
2929

30-
3130
## Quick Start
3231

3332
```bash
@@ -42,23 +41,22 @@ npm test
4241

4342
Tired of repetitive setup, inconsistent code, and integration headaches? See how `js-quality-started` provides a superior foundation compared to starting from scratch or using basic boilerplates.
4443

45-
| Criteria | Minimal/Empty Repository | Basic Boilerplate | `js-quality-started` Template |
46-
| :---------------------------- | :----------------------- | :------------------------------------- | :---------------------------- |
47-
| **Core Purpose** | Blank slate | Quick start, basic structure | Quality, consistency, efficiency |
48-
| **Linting (e.g., ESLint)** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured, opinionated |
49-
| **Formatting (e.g., Prettier)** | ❌ No | ⚙️ Manual setup required | ✅ Pre-configured |
50-
| **Testing Framework (e.g., Jest)** | ❌ No | ⚙️ Manual setup required | ✅ Pre-configured with coverage |
51-
| **Test Coverage Reporting** | ❌ No | ❌ No | ✅ Included |
52-
| **Build/Bundling Tool** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured (e.g., Babel) |
53-
| **Language Support** | JS Only | JS Only | JS (easily extensible to TS) |
54-
| **Documentation Gen. Tools** | ❌ No | ❌ No | ⚙️ Manual add/Configuring |
55-
| **CI/CD Configuration** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured GitHub Actions |
56-
| **Community Health Files** | ❌ No | ⚙️ Basic `README.md` | ✅ Comprehensive (`README`, `CONTRIBUTING`, `LICENSE`, etc.) |
57-
| **Opinionation Level** | None | Low | High (for quality tools) |
58-
| **Initial Setup Time** | Very High | High | Very Low |
59-
| **Code Quality Assurance** | Manual | Limited / Manual | Automated & Proactive |
60-
| **Team Collaboration Aid** | Low | Moderate | High |
61-
44+
| Criteria | Minimal/Empty Repository | Basic Boilerplate | `js-quality-started` Template |
45+
| :--------------------------------- | :----------------------- | :------------------------------- | :----------------------------------------------------------- |
46+
| **Core Purpose** | Blank slate | Quick start, basic structure | Quality, consistency, efficiency |
47+
| **Linting (e.g., ESLint)** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured, opinionated |
48+
| **Formatting (e.g., Prettier)** | ❌ No | ⚙️ Manual setup required | ✅ Pre-configured |
49+
| **Testing Framework (e.g., Jest)** | ❌ No | ⚙️ Manual setup required | ✅ Pre-configured with coverage |
50+
| **Test Coverage Reporting** | ❌ No | ❌ No | ✅ Included |
51+
| **Build/Bundling Tool** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured (e.g., Babel) |
52+
| **Language Support** | JS Only | JS Only | JS (easily extensible to TS) |
53+
| **Documentation Gen. Tools** | ❌ No | ❌ No | ⚙️ Manual add/Configuring |
54+
| **CI/CD Configuration** | ❌ No | ⚙️ Manual setup required / Basic | ✅ Pre-configured GitHub Actions |
55+
| **Community Health Files** | ❌ No | ⚙️ Basic `README.md` | ✅ Comprehensive (`README`, `CONTRIBUTING`, `LICENSE`, etc.) |
56+
| **Opinionation Level** | None | Low | High (for quality tools) |
57+
| **Initial Setup Time** | Very High | High | Very Low |
58+
| **Code Quality Assurance** | Manual | Limited / Manual | Automated & Proactive |
59+
| **Team Collaboration Aid** | Low | Moderate | High |
6260

6361
## What's Inside?
6462

0 commit comments

Comments
 (0)