From ce190621ad1440116a1a94d6ffc961401e4a028e Mon Sep 17 00:00:00 2001 From: ireic Date: Sun, 26 Jan 2020 15:18:27 +0100 Subject: [PATCH] Modified readme --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3ca0747..11021fd 100644 --- a/README.md +++ b/README.md @@ -14,25 +14,19 @@ ## What is this and who is it for 🤷‍♀️ -I do web development and UX design consulting and this is a showcase product I've built in my spare time. It is a very good example of what a modern real-world React codebase could look like. +I do React consulting and this is a showcase product I've built in my spare time. It's a very good example of modern, real-world React codebase. -There are many showcase/example React projects out there but most of them are way too simple. I like to think that this project contains enough complexity to offer valuable insights to React developers of all skill levels while still being relatively easy to understand. +There are many showcase/example React projects out there but most of them are way too simple. I like to think that this codebase contains enough complexity to offer valuable insights to React developers of all skill levels while still being _relatively_ easy to understand. ## Features -### Client - - Proven, scalable, and easy to understand project structure - Written in modern React, only functional components with hooks - A variety of custom light-weight UI components such as datepicker, modal, various form elements etc - Simple local React state management, without redux, mobx, or similar - Custom webpack setup, without create-react-app or similar -- Written in Babel powered JavaScript - -### API - -- Simple, scalable, and easy to understand project structure -- Written in TypeScript and using TypeORM +- Client written in Babel powered JavaScript +- API written in TypeScript and using TypeORM ## Setting up development environment 🛠