Readme.md for initialization

[ArthurFrin]

There is no Readme.md after initializing a new project. I think it would be a good idea to include a default README file with useful links and commands (e.g., Discord links, documentation, start commands, etc.).

Problem: There is already a Readme.md file in the starter kits, but it gets deleted during initialization by the create-adonis script.

Solutions: Add an init.md file in the starter kits and rename it to Readme.md after initialization.

Here is an example of a README file below:

Description

AdonisJS is a TypeScript-first web framework for building web apps and API servers. It comes with support for testing, modern tooling, an ecosystem of official

📚 AdonisJS Documentation

Run and Build

# development mode
npm run dev

# production mode
npm start

# build for production
npm run build

Run tests

npm run test

Deployment

For detailed deployment instructions, refer to the AdonisJS Deployment Guide.

[thetutlage]

Yup, sounds like a good idea. Can you open PRs in the official starter kits for the same?

[ArthurFrin]

Okay, I created the PR on the starter kit, but we shouldn't merge it until we've modified the initialization script to rename init.md to Readme.md.