add instructions to readme

Author: deiucanta

Diff for: README.md

@@ -1,40 +1,34 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Dockerizer
 
-## Getting Started
+> Provided by [Easypanel](https://easypanel.io)
 
-First, run the development server:
+## Codebase Structure
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+Each Dockerizer has its own folder: `src/dockerizers/[name]`
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
-
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+```
+index.ts          # dockerizer schema & generation logic
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+files/            # files, templates, config files
+files.json        # compiled from the files folder
 
-## Learn More
+tests/
+  [test-name]/
+    code/         # test application codebase
+    input.json    # test input for the dockerizer
+```
 
-To learn more about Next.js, take a look at the following resources:
+You can get started by copying the `sample` dockerizer.
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+On the UI, there is a one or more pages for each Dockerizer. Those live in `src/pages/[name]`
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+## Development
 
-## Deploy on Vercel
+Run `npm run dev` to start the Next.js application.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## Scripts
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+- `npm run compile-files` - compiles all the files from a dockerizer to `files.json`
+- `npm run compile-files-watch` - watches for changes and run `compile-files` automatically
+- `npm run compile-tests` - generates the `dockerizer` folder for each test app based on `input.json`
+- `npm run hadolint` - lints all Dockerfiles (make sure you run `compile-tests` before this)