📝 Update Readme with info

README.md

@@ -3,45 +3,54 @@
 A React Native app for educational purposes. Refer
 to [instructions here](https://react-native-courses.clubinfo-clermont.fr/docs/notation).
 
-+ [About](#about)
+- [About](#about)
-+ [Notation checklist](#notation-checklist)
+- [Notation checklist](#notation-checklist)
-+ [Sketches](#sketches)
+- [Sketches](#sketches)
-  - [Home](#home)
+    - [Home](#home)
-  - [Collection](#collection)
+    - [Collection](#collection)
-  - [Detail](#detail)
+    - [Detail](#detail)
-  - [Creating](#creating)
+    - [Creating](#creating)
-  - [Updating](#updating)
+    - [Updating](#updating)
-+ [Using the app](#using-the-app)
+- [Using the app](#using-the-app)
+    - [Running the backend](#running-the-backend)
+    - [Running this app](#running-this-app)
+- [Known limitations](#known-limitations)
+    - [Sparse](#sparse)
+    - [Hardcoded enums](#hardcoded-enums)
 
 ## About
 
+PoKeMoNg is a React Native application developed for educational purposes. The application is designed to showcase
+a "master/detail" view of `Moves`, with basic CRUD features. The application is linked to
+a [backend API](https://codefirst.iut.uca.fr/git/alexis.drai/pokemong_api) that provides the data for the Moves.
+
 ## Notation checklist
 
-* [ ] Documentation (6 pts)
+* [x] Documentation (6 pts)
-  - [x] Application sketches (4 pts)
+    - [x] Application sketches (4 pts)
-  - [ ] A Readme describing your project/application. (2 pts)
+    - [x] A Readme describing your project/application. (2 pts)
 * [x] Basics (20 pts)
-  - [x] Navigation (3 pts)
+    - [x] Navigation (3 pts)
-    + [x] Tab bottom navigation (2 pts) AND at least one button (1 pts)
+        + [x] Tab bottom navigation (2 pts) AND at least one button (1 pts)
-  - [x] Redux Store (10 pts)
+    - [x] Redux Store (10 pts)
-    + [x] Read data from redux store (2 pts)
+        + [x] Read data from redux store (2 pts)
-    + [x] Update data to redux store with actions and reducers (slice = 0) (4 pts)
+        + [x] Update data to redux store with actions and reducers (slice = 0) (4 pts)
-    + [x] Update data to redux store using redux-thunk (API AND|OR AsyncStorage) (4 pts)
+        + [x] Update data to redux store using redux-thunk (API AND|OR AsyncStorage) (4 pts)
-  - [x] Display list of items (2 pts)
+    - [x] Display list of items (2 pts)
-    + [x] FlatList, VirtualizedList or SectionList
+        + [x] FlatList, VirtualizedList or SectionList
-  - [ ] ~~Display dynamic image (2 pts)~~
+    - [ ] ~~Display dynamic image (2 pts)~~
-  - [x] Binding child component props (1 pts)
+    - [x] Binding child component props (1 pts)
-  - [x] Handle a TextInput correctly (2 pts)
+    - [x] Handle a TextInput correctly (2 pts)
-    + [x] Beware of keyboard management
+        + [x] Beware of keyboard management
 * [ ] Application features (14 pts)
-  - [x] Retrieve data using the Web API (6 pts)
+    - [x] Retrieve data using the Web API (6 pts)
-    + [x] Handle fetch success callback (3 pts)
+        + [x] Handle fetch success callback (3 pts)
-    + [x] Handle fetch error callback (3 pts)
+        + [x] Handle fetch error callback (3 pts)
-  - [ ] Store favorite data into phone storage (2 pts)
+    - [ ] Store favorite data into phone storage (2 pts)
-  - [ ] Write Tests (6 pts)
+    - [ ] Write Tests (6 pts)
-    + [ ] all actions payload (1 pts)
+        + [ ] all actions payload (1 pts)
-    + [ ] all reducers case (2 pts)
+        + [ ] all reducers case (2 pts)
-    + [x] one UI Component (3 pts)
+        + [x] one UI Component (3 pts)
 
 ## Sketches
 
@@ -49,26 +58,80 @@ This app will contain a home page, and a "master/detail" tab for `Moves` with ba
 
 ### Home
 
-<img src="./docs/home.png" width="540" style="margin:20px">
+The home screen provides a logo, and tab navigation options to other parts of the application.
+
+<img src="./docs/home.png" width="410" style="margin:20px">
 
 ### Collection
 
-<img src="./docs/moves.png" width="540" style="margin:20px">
+The collection screen displays a list of `Moves` fetched from the API.
+
+<img src="./docs/moves.png" width="410" style="margin:20px">
 
 ### Detail
 
-<img src="./docs/move.png" width="540" style="margin:20px">
+The detail screen displays detailed information about a selected `Move`.
+
+<img src="./docs/move.png" width="410" style="margin:20px">
 
 ### Creating
 
-<img src="./docs/create.png" width="540" style="margin:20px">
+The creating screen provides a form for creating a new `Move`.
+
+<img src="./docs/create.png" width="410" style="margin:20px">
 
 ### Updating
 
-<img src="./docs/update.png" width="540" style="margin:20px">
+The updating screen provides a form for updating an existing `Move`.
+
+<img src="./docs/update.png" width="410" style="margin:20px">
 
 ## Using the app
 
-This app is linked to a backend that is set up to accept CORS from [`http://localhost:19006`](http://localhost:19006).
+### Running the backend
-If you want to use the dedicated API, please make sure you're not overriding that default port number when running this
+
-app.
+In order to use this app, you will need to run the dedicated backend. A `README`
+with [instructions](https://codefirst.iut.uca.fr/git/alexis.drai/pokemong_api#user-content-prep-steps) is provided
+for that purpose.
+
+### Running this app
+
+With the [Expo CLI](https://docs.expo.dev/more/expo-cli/) installed, at the root of the project, simply run
+
+```bash
+npx expo start
+```
+
+or
+
+```bash
+yarn start
+```
+
+The app should launch successfully, and instructions should be provided in terminal to open it on a number of devices.
+
+## Known limitations
+
+Beside whatever items may not have been checked off the [notation checklist](#notation-checklist), there are also
+a number of known limitations and issues with this app.
+
+### Sparse
+
+See #4, #5, #9
+
+Even though the API provides [a variety of entities](https://codefirst.iut.uca.fr/git/alexis.drai/pokemong_api#about)
+with fun business logic, this app only implemented a "master/detail" and the basic CRUD features on one entity: `Move`.
+
+In short, for lack of time, this app doesn't quite manage to do anything beyond the basic requirements. It doesn't
+use the API to its full potential, and the API doesn't really get a legitimate reason to provide even more interesting
+routes (for instance, aggregation pipelines and filtered searches).
+
+### Hardcoded enums
+
+See #12
+
+Enums of values such as `TypeName` and `MoveCategoryName` are defined by the API. The API provides an OAS, so we could
+get those enums dynamically instead of copying and pasting them in this front-end project.
+
+Of course, that may increase complexity beyond the scope of this project, and it may impact performance negatively --
+but it seems like something we would take care of before deploying this app to production, in real-world conditions.