update readme, disable i18n until handled

boilerplate.js

@@ -242,9 +242,10 @@ async function install (context) {
       })
     }
 
-    if (pluginAnswers['i18n'] === 'react-native-i18n') {
-      await system.spawn(`ignite add i18n ${debugFlag}`, { stdio: 'inherit' })
-    }
+    // todo handle i18n
+    // if (pluginAnswers['i18n'] === 'react-native-i18n') {
+    //   await system.spawn(`ignite add i18n ${debugFlag}`, { stdio: 'inherit' })
+    // }
 
     if (pluginAnswers['animatable'] === 'react-native-animatable') {
       await system.spawn(`ignite add animatable ${debugFlag}`, {

options.js

@@ -24,12 +24,12 @@ const pluginQuestions = [
     type: 'list',
     choices: ['none', 'react-native-vector-icons']
   },
-  {
-    name: 'i18n',
-    message: 'What internationalization library will you use?',
-    type: 'list',
-    choices: ['none', 'react-native-i18n']
-  },
+  // {
+  //   name: 'i18n',
+  //   message: 'What internationalization library will you use?',
+  //   type: 'list',
+  //   choices: ['none', 'react-native-i18n']
+  // },
   {
     name: 'animatable',
     message: 'What animation library will you use?',
@@ -46,7 +46,7 @@ const max = {
   'auth-type': 'jwt',
   'dev-screens': 'Yes',
   'vector-icons': 'react-native-vector-icons',
-  i18n: 'react-native-i18n',
+  // i18n: 'react-native-i18n',
   animatable: 'react-native-animatable'
 }
 
@@ -57,7 +57,7 @@ const min = {
   'auth-type': 'jwt',
   'dev-screens': 'No',
   'vector-icons': 'none',
-  i18n: 'none',
+  // i18n: 'none',
   animatable: 'none'
 }
 

readme.md

@@ -2,44 +2,57 @@
 
 A React Native boilerplate for JHipster apps.
 
-This module uses Infinite Red's [Ignite generator](https://github.com/infinitered/ignite) and is heavily based off of [ignite-ir-boilerplate-2016](https://github.com/infinitered/ignite-ir-boilerplate-2016),
- but with a few JHipster twists.
+This module uses Infinite Red's [Ignite generator](https://github.com/infinitered/ignite) and is heavily based off of
+ [ignite-ir-boilerplate-2016](https://github.com/infinitered/ignite-ir-boilerplate-2016), but with a few JHipster twists.
 
-Planned Features:
-
- - [x] Home Page
- - [x] User Authentication (Login/Logout for JWT, UAA and Oauth2)
- - [ ] User Pages - *In Progress*
-     - [x] User Settings
-     - [x] Register
-     - [ ] Reset Password
-     - [ ] Change Password
-
- - [ ] Entity Generator
-     - [ ] API 
-     - [ ] Listings Page
-     - [ ] Detail Page
-     - [ ] Edit Page
-
- - [ ] Websocket Support
- - [ ] Admin Pages (optional)
- - [ ] Internationalization
- - [ ] Social Login
 
 ## Getting Started
-The requirements for running the generator include:
- - Node v7.7+
- - [ignite-cli](https://github.com/infinitered/ignite) installed (v2+)
+#### Requirements
+ - Node v7.6+
+    - Verify version with `node -v`
+ - [React Native setup](https://facebook.github.io/react-native/docs/getting-started.html#content)
+ - [ignite-cli](https://github.com/infinitered/ignite) installed (>= v2.0.0)
+    - Install with `npm install -g ignite-cli`
     - Verify version with `ignite --version`
 
-Running the generator will create a new directory containing the project.  It also installs react-native and sets up 
-directories for Android and iOS apps.   
-
 #### Example
 
 ```js
 ignite new SampleApp --boilerplate ignite-jhipster
 ```
 
-Because the boilerplate is based on Ignite, we gain access to other generators and plugins.  Check out
- [Ignite's documentation](https://github.com/infinitered/ignite/tree/master/docs) for more details. 
+Answer the prompts (choose your JHipster auth type and any plugins you want) and wait for the project to finish generation.  
+The generator will create a new directory containing the project.  It also sets up the Android and iOS app directories.
+
+#### Configuration
+
+In `AppConfig.js`, set your JHipster app's API url.  If you use UAA and use a uaaBasePath other than `uaa`, change that as well.
+
+### Generators
+
+Entity generator coming soon!  Because the boilerplate is based on Ignite, we also gain access to other generators and plugins:
+ - Screen
+ - Component
+ - Service
+ - Redux
+ - Saga
+
+Check out [Ignite's documentation](https://github.com/infinitered/ignite/tree/master/docs) for more details. 
+
+
+### Planned Features:
+V1
+ - [x] Home Page
+ - [x] User Authentication (Login/Logout for JWT, UAA and Oauth2)
+ - [x] User Pages (Register, Change/Reset Password, Settings)
+ - [ ] Entity Generator - *In Progress*
+     - [ ] API 
+     - [ ] Listings Page
+     - [ ] Detail Page
+     - [ ] Edit Page
+
+Later Features
+ - [ ] Websocket Support
+ - [ ] Admin Pages
+ - [ ] Internationalization
+ - [ ] Social Login