diff --git a/README.md b/README.md index a72b117..e11f5a1 100644 --- a/README.md +++ b/README.md @@ -9,26 +9,27 @@ ## 🌟 Features -- 🔻 [Ruby (3.3.1) and Rails (7.1)](https://rubyonrails.org) -- 🐘 [PostgresSQL 16.3](https://www.postgresql.org) -- 💨 [Tailwind CSS](https://tailwindcss.com) -- 🛠 Uses [Vite Ruby](https://vite-ruby.netlify.app) for asset management. It is based on [Vite.js](https://vitejs.dev). It replaces webpacker, jsbundling-rails, cssbundling-rails, importmaps and sprockets. -- 🍞 Uses [Bun](https://bun.sh) for npm package manager. No need to install node and yarn. -- 🖼 Uses [Phlex](https://www.phlex.fun) for component-based views. It is an alternative to [ViewComponent](https://viewcomponent.org). -- 🔍 Uses Rails' default testing library, minitest along with [Factorybot](https://github.com/thoughtbot/factory_bot) -- 📏 Auto-formats Ruby code with [rubocop](https://rubocop.org). -- ✨ Auto-formats JavaScript and CSS code with [prettier](https://prettier.io). -- 🚀 Uses Github Actions for continuous integration and deployment. -- 🌐 Supports deployment at [Heroku](https://www.heroku.com/platform) and [Render](https://render.com) +- **Ruby**: Ruby 3.3.1 +- **Rails**: [Rails 7.1](https://rubyonrails.org) +- **PostgreSQL**: [PostgresSQL 16.3](https://www.postgresql.org) +- **Tailwind CSS**: Uses [Tailwind CSS](https://tailwindcss.com) for styling. +- **Vite Ruby**: Uses [Vite Ruby](https://vite-ruby.netlify.app) for asset management. It is based on [Vite.js](https://vitejs.dev). It replaces webpacker, jsbundling-rails, cssbundling-rails, importmaps and sprockets. +- **Bun**: Uses [Bun](https://bun.sh) for npm package manager. No need to install node and yarn. +-**Phlex**: Uses [Phlex](https://www.phlex.fun) for component-based views. It is an alternative to [ViewComponent](https://viewcomponent.org). +- **Minitest/FactoryBot**: Uses Rails' default testing library, minitest along with [Factorybot](https://github.com/thoughtbot/factory_bot) +- **Rubocop**: Auto-formats Ruby code with [rubocop](https://rubocop.org). +- **Prettier**: Auto-formats JavaScript and CSS code with [prettier](https://prettier.io). +- **Github Actions**: Uses Github Actions for continuous integration and deployment. +- **Deployment**: Supports deployment at [Heroku](https://www.heroku.com/platform) and [Render](https://render.com) ## Usage ### Prerequisites -- Ruby 3.3 +- Ruby 3.3.1 - Check the [.ruby-version](.ruby-version) - PostgreSQL 16.3 -- Bun +- Bun 1.1.8 Refer [installing prerequisites](./docs/installing_prerequisites.md) to install these dependencies