Updated README

- **Added Links & New Technical Detail**: New links to the changelog, roadmap, contributing, license and code of conduct were added, also rephrased some of the sentences to better reflect what it does
burgil · Oct 20, 2024 · bfbf613 · bfbf613
1 parent dc7e9b5
commit bfbf613
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 ## Changelog
 
+### Version 1.7.4 - Updated README
+
+- **Added Links & New Technical Detail**: New links to the changelog, roadmap, contributing, license and code of conduct were added, also rephrased some of the sentences to better reflect what it does
+
 ### Version 1.7.3 - Runtime CLI option
 
 - **Specify the runtime via the CLI**: Support for deno is almost complete

diff --git a/README.md b/README.md
@@ -12,9 +12,9 @@ This is the first package under the @supeprojects scope, with more planned for t
 
 Supe Project Creator is a simple tool designed to help you build simple web applications quickly and efficiently. It generates project templates boilerplate using **TypeScript**, **HTML**, and **CSS**, with included **hot reloading** for a seamless development workflow. But there's a catch - the generated project has no dependencies, a fresh start. All the source code that runs the project will be waiting for you in the generated project folder, no strings attached. It's as simple as you can get.
 
-[JSR](https://jsr.io/@supeprojects/supe-project-creator) - [Source Code](https://github.com/burgil/supe-project-creator) - [Known Issues](https://github.com/burgil/supe-project-creator/issues) - [Docs/Wiki](https://github.com/burgil/supe-project-creator/wiki)
+[JSR](https://jsr.io/@supeprojects/supe-project-creator) - [Source Code](https://github.com/burgil/supe-project-creator) - [Known Issues](https://github.com/burgil/supe-project-creator/issues) - [Docs/Wiki](https://github.com/burgil/supe-project-creator/wiki) - [Changelog](https://github.com/burgil/supe-project-creator/blob/main/CHANGELOG.md) - [Roadmap](https://github.com/burgil/supe-project-creator/blob/main/ROADMAP.md) - [Contributing](https://github.com/burgil/supe-project-creator/blob/main/CONTRIBUTING.md) - [Code of Conduct](https://github.com/burgil/supe-project-creator/blob/main/CODE_OF_CONDUCT.md) - [License](https://github.com/burgil/supe-project-creator/blob/main/LICENSE)
 
-**For a bit of technical detail:** how it does all of that is thanks to the built-in TypeScript compilers in the new runtimes. To avoid downloading dependencies, it uses `bunx` (an `npx` alternative) to fetch packages like `http-server`, `nodemon`, and `esbuild`.
+**For a bit of technical detail:** how it does all of that is thanks to the built-in TypeScript compilers in the new runtimes. This approach uses globally installed `http-server`, `nodemon`, and `esbuild` packages, eliminating the need for additional dependency downloads.
 
 > [!NOTE]
 > The created project is client-only. You are welcome to combine Supe Project Creator with any other server framework, such as Express.JS, FastAPI, Cloudflare Workers, etc.

diff --git a/deno.json b/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@supeprojects/supe-project-creator",
-  "version": "1.7.3",
+  "version": "1.7.4",
   "license": "MIT",
   "exports": "./index.ts",
   "tasks": {

diff --git a/index.ts b/index.ts
@@ -40,7 +40,7 @@ export default function SupeProjectCreator(argv: string[]): void {
     // Variables:
     let CleanProject = true;
     let projectName = '';
-    const supeVersion = '1.7.3';
+    const supeVersion = '1.7.4';
     const supeVersionDate = '2024-10-16';
     let runtime: 'deno' | 'bun' | 'node' | 'none' = 'none';
     if (argv.length === 0) argv.push('--help');

diff --git a/jsr.json b/jsr.json
@@ -1,6 +1,6 @@
 {
     "name": "@supeprojects/supe-project-creator",
-    "version": "1.7.3",
+    "version": "1.7.4",
     "exports": "./index.ts",
     "license": "MIT"
 }