Merge remote-tracking branch 'origin/dependabot/npm_and_yarn/examples…

…/main-demo/npm_and_yarn-3ec9577c7f' into develop
mnfst · Oct 21, 2024 · d08f039 · d08f039
2 parents d2544f9 + dd605b3
commit d08f039
Show file tree

Hide file tree

Showing 5 changed files with 105 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -22,35 +22,32 @@
 
 [Manifest](https://manifest.build) is the simplest backend you can find:
 
-<a href="https://stackblitz.com/fork/github/mnfst/manifest/tree/master/examples/main-demo?file=manifest/backend.yml" target="_blank"><img alt="Open in StackBlitz" src="https://developer.stackblitz.com/img/open_in_stackblitz.svg"></a>
-
 ```yaml
 # manifest/backend.yml
-name: Healthcare application
+name: Healthcare application 🏥
 
 entities:
-  👩🏾‍⚕️ Doctor:
+  Doctor 👩🏾‍⚕️:
     properties:
       - fullName
       - avatar
       - { name: price, type: money, options: { currency: EUR } }
     belongsTo:
       - City
 
-  🤒 Patient:
+  Patient 🤒:
     properties:
       - fullName
       - { name: birthdate, type: date }
     belongsTo:
       - Doctor
 
-  🌍 City:
+  City 🌍:
     properties:
       - name
 ```
 
-> [!NOTE]  
-> Manifest is on BETA. We would love to have your feedback! If something does not work as expected, please [open a Github issue](https://github.com/mnfst/manifest/issues/new/choose). For any other thing, let us know through [The Manifest Discord channel](https://discord.com/invite/FepAked3W7).
+<a href="https://stackblitz.com/fork/github/mnfst/manifest/tree/master/examples/main-demo?file=manifest/backend.yml" target="_blank"><img alt="Open in StackBlitz" src="https://developer.stackblitz.com/img/open_in_stackblitz.svg"></a>
 
 ## Key features
 
@@ -60,24 +57,27 @@ entities:
 
 ## Getting started
 
-Simply run this terminal command to add Manifest:
+Simply run this terminal command to add Manifest locally:
 
 ```bash
 npx add-manifest
 ```
 
+> [!NOTE]  
+> Manifest is on BETA. We would love to have your feedback! If something does not work as expected, please [open a Github issue](https://github.com/mnfst/manifest/issues/new/choose). For any other thing, let us know through [The Manifest Discord channel](https://discord.com/invite/FepAked3W7).
+
 ## Product roadmap
 
 Our mission is to enable developers of all experience levels to create and share innovative solutions. As an **open source** product, we continuously improve Manifest through community collaboration. After our successful PoC, we are further developing the product with your feedback. Here are the upcoming features:
 
-| Feature          | Description                                                 | Release date | Status         |
-| ---------------- | ----------------------------------------------------------- | ------------ | -------------- |
-| **OpenAPI Doc**  | Instant live documentation for your REST API                | July 2024    | ✅ Available   |
-| **Auth**         | Make any entity authenticatable and add rules for endpoints | August 2024  | ✅ Available   |
-| **Validation**   | Custom validation for creating and updating items           | Q4 2024      | 🚧 In progress |
-| **Many-to-many** | Advanced relationship management                            | Q4 2024      | 📝 To specify  |
-| **Hooks**        | Trigger webhooks at specific events                         | Q4 2024      | 📝 To specify  |
-| **Media upload** | Allow file and image uploads with rules and resizing        | Q4 2024      | 📝 To specify  |
+| Feature          | Description                                                 | Release date | Status        |
+| ---------------- | ----------------------------------------------------------- | ------------ | ------------- |
+| **OpenAPI Doc**  | Instant live documentation for your REST API                | July 2024    | ✅ Available  |
+| **Auth**         | Make any entity authenticatable and add rules for endpoints | August 2024  | ✅ Available  |
+| **Validation**   | Custom validation for creating and updating items           | Q4 2024      | ✅ Available  |
+| **Many-to-many** | Advanced relationship management                            | Q4 2024      | ✅ Available  |
+| **Media upload** | Allow file and image uploads with rules and resizing        | Q4 2024      | ✅ Available  |
+| **Hooks**        | Trigger webhooks at specific events                         | Q4 2024      | 📝 To specify |
 
 🆕 [Suggest a new feature for the next versions](https://github.com/mnfst/manifest/discussions/new?category=feature-request)
 
@@ -89,6 +89,8 @@ Our mission is to enable developers of all experience levels to create and share
 
 ## Contributors
 
+We welcome contributions to Manifest, Please see our [Contributing Guidelines](./CONTRIBUTING.md) to get started and join the journey.
+
 Thanks to our first wonderful contributors!
 
 <a href="https://github.com/mnfst/manifest/graphs/contributors">