From 6ea81104bc09a30d9bbeaff36a953e1460038ceb Mon Sep 17 00:00:00 2001
From: Shubham Rathore <61877-shubhamrathore01@users.noreply.drupalcode.org>
Date: Mon, 9 Jan 2023 17:54:11 +0530
Subject: [PATCH] Issue #3331712: Update README.md as per README.md format
---
README.md | 52 ++++++++++++++++++++++++++++++++++++++++------------
1 file changed, 40 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index cc363b3..43299d9 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,45 @@
# JSON:API Extras
-This module provides extra functionality on top of JSON:API. You should not
-need this module to get an spec compliant JSON:API, this module is to
-customize the output of JSON:API.
+The JSON:API module in code provides zero configuration out of the box. Use JSON:API
+Extras to customize your API. JSON:API Extras provides a means to override and provide
+limited configurations to the default zero-configuration implementation provided by the
+JSON:API in Core.
-This module adds the following features:
+For a full description of the module, visit the
+[project page](https://www.drupal.org/project/jsonapi_extras).
- - Allows you to customize the URL for your resource under the `/jsonapi`
- prefix.
- - Allows you to customize the resource type to other than
- `${entityTypeId}--${bundle}`.
- - Lets you remove fields from the JSON:API output.
+Submit bug reports and feature suggestions, or track changes in the
+[issue queue](https://www.drupal.org/project/issues/jsonapi_extras).
-TODO:
- * Auto calculate the dependency of the provider of the entity type and
- bundles in the configuration entity.
+
+## Table of contents
+
+- Requirements
+- Installation
+- Configuration
+- Maintainers
+
+
+## Requirements
+
+This module requires no modules outside of Drupal core.
+
+
+## Installation
+
+Install as you would normally install a contributed Drupal module. For further
+information, see
+[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
+
+
+## Configuration
+
+The module has no menu or modifiable settings. There is no configuration. When
+enabled, the module will prevent the links from appearing. To get the links
+back, disable the module and clear caches.
+
+
+## Maintainers
+
+- Mateu Aguiló Bosch - [e0ipso](https://www.drupal.org/u/e0ipso)
+- Björn Brala - [bbrala](https://www.drupal.org/u/bbrala)
--
GitLab