From dad4496488ac62c87e99e3efe76a14c901bbc279 Mon Sep 17 00:00:00 2001 From: Dorian Niemiec Date: Mon, 2 Sep 2024 07:42:28 +0200 Subject: [PATCH] docs: update file structure in README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index e8546e5..7a52ff3 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,7 @@ You can read the [SVR.JS documentation](https://svrjs.org/docs/tentative) to get ## File structure The file structure for SVR.JS source code looks like this: + - .husky - Git hooks - assets - files to copy into dist folder and to the archive - dist - contains SVR.JS, assets, and SVR.JS utiltiies - generatedAssets - assets generated by the build script @@ -131,9 +132,12 @@ The file structure for SVR.JS source code looks like this: - middleware - tests for middleware - utils - unit tests for utility functions - utils - SVR.JS utilities (each utility has a single file) + - commitlint.config.js - commitlint configuration - esbuild.config.js - the build script - eslint.config.js - ESLint configuration - jest.config.js - Jest configuration + - lint-staged.config.js - lint-staged configuration + - prettier.config.js - Prettier configuration - svrjs.json - SVR.JS version, name, documentation URL, and statistics server collection endpoint URL ## Contribute