Merge pull request #6 from pennylane-hq/ar/update-readme

chore: update the instructions to make sure candidates have what they need

Author: adrien-pennylane

README.md

@@ -1,38 +1,38 @@
 # Jean Test Mobile
 
-JeanTest is a React Native invoicing mobile application. It is used by business owners to create & manage invoices with their customers.
+JeanTest is a React Native invoicing mobile application. It is used by business owners to create and manage invoices with their customers.
 
 This repository contains the skeleton of JeanTest & instructions for this React Native hiring test.
 
 ## Mission
 
 Your goal is to build a feature-rich prototype of JeanTest that allows to:
 
-- List & quickly find invoices
-- Create new invoices
-- Manage existing invoices
+- **List & quickly find invoices**
+- **Create new invoices**
+- **Manage existing invoices**
   - Move them from drafts to finalized invoices
   - Mark them as paid
   - Update them
   - Delete them
 
-You'll be leveraging an existing REST HTTP API hosted at `https://jean-test-api.herokuapp.com/`.
+For this, you'll be leveraging an existing REST HTTP API hosted at `https://jean-test-api.herokuapp.com/`.
 
-The API is documented with [OpenAPI](https://www.openapis.org/) & has a documentation available [here](https://jean-test-api.herokuapp.com/api-docs/index.html). Each API call must be authenticated using a `X-SESSION` header with the provided token.
+The API is documented with [OpenAPI](https://www.openapis.org/) and has documentation available [here](https://jean-test-api.herokuapp.com/api-docs/index.html). Each API call must be authenticated using an `X-SESSION` header with the provided token.
 
 ### What's expected
 
-JeanTest should contain essential features listed above & be coded in a way that makes it intuitive, performant & maintainable.
+Your exercise submission should:
 
-We expect you to adopt standard coding practices, including testing, as if you were working on a real-world application with other coworkers.
-
-We want you to **build JeanTest from existing UI components provided in `src/ui`** by [Tamagui](https://tamagui.dev/ui/intro?subpath=intro) in order to focus on composing screens & features. Feel free to add new ones but keep in mind that it won't be taken into account.
-
-We encourage you to use pre-installed dependencies or add new ones if you have a legitimate use of them.
+- **Have the essential features** listed above while maintaining an intuitive, performant, and maintainable codebase.
+- **Follow the standard coding practices** and include testing, just as you would when developing a real-world application with teammates.
+- **Leverage existing UI components** provided in `src/ui` by Tamagui to focus on composing screens and features. While you're welcome to add a new UI library, you'll need to justify such an addition.
+- **Use pre-installed dependencies** or add new ones if you have a legitimate use of them.
+- **Create a clear README** with comprehensive instructions for setup, usage, additional features, etc.
 
 ### The interview
 
-In order to prepare the interview, please take the time to identify advanced features that could be added in the future (even if the API currently does not support it!).
+To prepare the interview, please take the time to identify advanced features that could be added in the future (even if the API currently does not support it!).
 
 For each feature/tech improvement, we want to understand:
 
@@ -42,15 +42,15 @@ For each feature/tech improvement, we want to understand:
 
 ### Submit your application
 
-In order to send your code, please create a private GitHub repository containing the source code of your application.
+To submit your code, create a private GitHub repository with your application's source code.
 
-Invite the following GitHub users to it: `@julienpinquie` `@soyoh` `@LucaGaspa` `@greeeg`
+Invite the following GitHub users to it: @adrien-pennylane @keShraa @Lecsar @michaelvitello
 
 ## Getting started
 
-In order to get started, clone this repository & run the `bin/setup` bash script which will install dependencies & take care of autogenerated files.
+To get started, clone this repository & run the `bin/setup` bash script which will install dependencies & take care of autogenerated files.
 
-```sh
+```bash
 git clone [email protected]:pennylane-hq/jean_test_mobile.git
 
 cd jean_test_mobile
@@ -62,21 +62,20 @@ yarn start
 yarn ios
 ```
 
-Make sure to add your `API_TOKEN` in `src/App.tsx` to send authenticated requests to the API.
+To start sending authenticated requests to the API, patch the `API_TOKEN` in `src/App.tsx`.
 
 ### Data model
 
-The REST API contains 4 resources: customers, products, invoices & invoice lines.
+The REST API contains four resources: customers, products, invoices and invoice lines.
 
 Side notes:
 
 - Invoices contain multiple invoice lines.
 - Invoice lines are accessed via their invoice. To update them, use the relevant invoice API endpoints.
-- Once the `finalized` field is set to `true` for invoices, no field may be modified except for `paid`.
 
 ### API client
 
-An API client based on `openapi-client-axios` is available through a React Context set up in `src/api/index.tsx`. The provider is mounted in `src/App.tsx` & the context can be consumed using the `useApi` hook from `src/api/index.tsx`.
+An API client based on `openapi-client-axios` is available through a React Context in `src/api/index.tsx`. The provider is mounted in `src/App.tsx` & the context can be consumed using the `useApi` hook from `src/api/index.tsx`.
 
 ```tsx
 const MyComponent = () => {
@@ -101,4 +100,7 @@ const MyComponent = () => {
 
   return null;
 };
+
 ```
+
+Good luck & Happy coding!