added web-client README

nimiq · Apr 10, 2024 · b877507 · b877507
1 parent a1de658
commit b877507
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ node_modules
 
 # Ignore dynamically built web-client docs
 build/web-client
+!build/web-client/README.md
 
 # Ignore dynamically built RPC spec docs
 build/rpc-docs/.version

diff --git a/build/web-client/README.md b/build/web-client/README.md
@@ -0,0 +1,3 @@
+# Web Client Docs
+
+The documentation for this folder is being automatically generated by the build process in the [`web-client.ts`](../../.vitepress/scripts/web-client.ts) script that runs when the `build` script is executed. This script run the `build:web-client` script that you can see in the `package.json` file.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Web Client Docs

		The documentation for this folder is being automatically generated by the build process in the [`web-client.ts`](../../.vitepress/scripts/web-client.ts) script that runs when the `build` script is executed. This script run the `build:web-client` script that you can see in the `package.json` file.