Documentation updates (#39)

CONTRIBUTING.md

@@ -1,47 +1,33 @@
-# We really love to have you and your awesome (intention) contributions here. 🎉🎉🎉 Thanks 🎉🎉🎉
+# So you're interested in contributing to this generator? 🎉🎉🎉 That's Great! 🎉🎉🎉
 
 ## To run the application in development
 
-### Step 1 👍 : install [yeoman](https://yeoman.io/)
+### Step 1 👍 : setup JHipster locally
 
-`npm install -g yo | yarn global add yo`
-
-### Step 2 👍 : to setup JHipster locally
-
-`git clone https://github.com/jhipster/generator-jhipster`
-
-`cd generator-jhipster`
-
-`npm install | yarn`
-
-`npm link | yarn link`
+* `git clone https://github.com/jhipster/generator-jhipster`
+* `cd generator-jhipster`
+* `npm install` -or- `yarn`
+* `npm link` -or- `yarn link`
 
 ( 🏁 Kudos, you just setup JHipster and linked to it locally )
 
-### Step 3 ✌️ : to setup JHipster-Micronaut generator
-
-`git clone https://github.com/generator-jhipster/generator-jhipster-micronaut`
+### Step 2 ✌️ : setup the JHipster-Micronaut generator locally
 
-`cd jhipster-micronaut`
-
-`npm link generator-jhipster | yarn link generator-jhipster`
-
-`npm install | yarn`
-
-`npm link | yarn link`
+* `git clone https://github.com/generator-jhipster/generator-jhipster-micronaut`
+* `cd generator-jhipster-micronaut`
+* `npm link generator-jhipster` -or- `yarn link generator-jhipster`
+* `npm install` -or- `yarn`
+* `npm link` -or- `yarn link`
 
 ( 🏁 Kudos, you just setup JHipster-Micronaut and linked to it locally )
-( 📝 Note: you are linking the JHipster to JHipster-Micronaut with the final command)
-
-### Step 4 🤟 : before generating your application, go to your application folder
-
-`yarn link "generator-jhipster-micronaut"`
+( 📝 Note: you have linked JHipster to JHipster-Micronaut)
 
-or
+### Step 3 🤟 : before generating your application, go to your application folder
 
-`npm link "generator-jhipster-micronaut"`
+* `npm link "generator-jhipster-micronaut"` -or- `yarn link "generator-jhipster-micronaut"`
+* `mhipster`
 
-( 🏁 Kudos, you have done it. It is the time to generate the application `mhipster` )
+( 🏁 Kudos, you have done it! It is the time to generate the application )
 
 ✨✨✨✨ You are rocking ✨✨✨✨
 

README.md

@@ -3,12 +3,22 @@
 
 # Greetings, Micronaut Hipster!
 
-This project generates a Micronaut based JHipster application 😎. It is based on JHipster Blueprint 🔵, and intends to replace the `spring-boot` portions of the server with Micronaut equivalents
+This project generates a Micronaut based JHipster application 😎.
+It is based on JHipster Blueprint 🔵, and intends to replace the `spring-boot` portions of the server with Micronaut equivalents.
 
 ## Currently supported options
-- Monolith only
-- maven or gradle
+* Monolith projects
+* JWT or OAuth 2.0 Authentication
+* SQL Database Support
+  * MySQL
+  * PostgreSQL
+  * H2
+* Ehcache
+* Maven or Gradle Build System
+* Angular or React Client
+* Protractor Tests
 
 ## ❤️ for community
 
-Interested in contributing, check out our [contributing guide](https://github.com/jhipster/generator-jhipster-micronaut/blob/master/CONTRIBUTING.md) to get started.
+Interested in contributing?
+Check out our [contributing guide](https://github.com/jhipster/generator-jhipster-micronaut/blob/master/CONTRIBUTING.md) to get started.