beckn / beckn/generic-client-layer

ReadME review and update for generic-client layer

Open
#35 0 comments 0 reactions 1 assignee Claimed by @em-abee View on GitHub
documentation generic-client-layer
Dominant language
TypeScript
Stars
4
Forks
3
PR merge metrics
No merged PRs in 30d

Description

## Description

Generic client layer repository has some documentation about the project and source, but it does not seem to be in line with the actual source code, it needs review and update. Also, it has some of the sections missing. It must should contain the below sections.

1. Project Title and Description:Clearly state the project name and provide a concise description of its purpose and functionalities.
2. Table of Contents (Optional):Include a table of contents for longer READMEs, especially if you have multiple sections.
3. Installation Instructions:Detail the steps required to set up and run the project, including any dependencies and system requirements.
4. Usage Instructions: Explain where is this required and how to use the project, including basic commands, functionalities, and relevant examples.

**Use [this](https://fide-official.atlassian.net/wiki/spaces/BPM1/pages/45908109/Document+Structure+for+README) format to update the redaMe documentation.**

## Goals

- [ ] Clear, correct, and detailed documentation about the repository.

## Expected Outcome

User should be able to understand the functionality/usage and how-to of the project by reading the documentation.

## Acceptance Criteria

- [ ] Correctly updated documentation for generic-client layer repository.

## Implementation Details

NA

## Mockups / Wireframes

NA

---

[Please note that the below section of the ticket ****has to be in the format as mentioned as it is key to enabling proper listing of the project.**** Please only choose the options mentioned under the headings wherever applicable.]

### Product Name

generic-client-layer

### Project Name

generic-client-layer

### Tech Skills Needed:

generic-client-layer knowledge

### Complexity

Low

### Category

documentation

### Sub Category

Documentation

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.