Add Documentation

[Sachindu-Nethmin]

Add Documentation

Purpose

Examples

Checklist

• Linked to an issue
• Updated the changelog
• Added tests
• Updated the spec
• Checked native-image compatibility

[aashikam]

@Sachindu-Nethmin Hi, I added a small comment, rest of it looks fine.

[Sachindu-Nethmin]

@aashikam please review

[aashikam]

@Sachindu-Nethmin Hey

Hiding sensitive information such as access tokens and client IDs in Git pull requests is critical to prevent unauthorized access and potential security breaches. Exposing such credentials can allow attackers to exploit your application, access restricted resources, or compromise user data, leading to serious damage.

7de1d1a This commit itself is a big security vulnerability. 😃

Even though you have removed it, by viewing the commit anyone still has access to the information.

To remove this from git history you will have to do a hard reset. Here are the steps:

1. Check the commit history: Run git log to view your commit history and identify the commit hash (e.g., abc123) you want to reset to.
2. Perform the hard reset: Execute git reset --hard <commit-hash> to move the branch pointer to the specified commit and discard any changes in the working directory or staging area.
3. Verify the reset: Run git log again to confirm the branch now points to the desired commit.
4. Push the changes: Use git push --force to overwrite the remote branch

After that please add an example. Here is a sample PR: ballerina-platform/module-ballerinax-dropbox#6

[aashikam]

@Sachindu-Nethmin Hey

Documentation includes all these files:

I see that you have only updated the README.md. It's pretty much the same content.
Here is a sample PR: ballerina-platform/module-ballerinax-dropbox#5