feat: updated Readme #101
Open
feat: updated Readme #101
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
@Arindam200 is there a reason why we are removing descriptions for the endpoint descriptions that currently exists in the Readme. They are definitely useful. So if we are removing them from here, we can repurpose it some where else like on our docs or in the readme for TS SDK. Let me know what do you think.
cc @mason-at-pieces
README.md
Outdated
| version: '0.0.1', | ||
| platform: Pieces.PlatformEnum.Macos, | ||
| } | ||
| 1. Fork this repository by clicking on the <a href="https://github.com/pieces-app/example-typescript/new/master?readme=1#fork-destination-box"><kbd><b>Fork</b></kbd></a> button. |
There was a problem hiding this comment.
Should this be added here for now? This would be only necessary when making a contribution right? We dont need to add it for doing local setup necessarily. So this points seems a bit unclear in the local setup.
README.md
Outdated
|
|
||
| If you discover any security-related issues, please email [security@pieces.app](mailto:security@pieces.app), or find a security contact in our [SECURITY.md](https://github.com/pieces-app/example-typescript/blob/main/SECURITY.md). |
There was a problem hiding this comment.
Security.md doesnt exist right now
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated the Readme of this Project:
