Updates readme #31
Merged
Updates readme #31
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
README.md
Outdated
|
|
||
| `near-social-viewer` is a [web component (custom element)](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) that implements the [near-social-vm](https://github.com/NearSocial/VM) for rendering code stored on-chain in the [SocialDB](https://github.com/NearSocial/social-db) smart contract (social.near). It is the simplest way to create your own [near social viewer](https://github.com/NearSocial/viewer) and it is the easiest method for embedding [Widgets](https://thewiki.near.page/near.social_widgets) into any web application. | ||
|
|
||
| <strong>The latest version of this package is deployed to [nearfs](https://github.com/vgrichina/nearfs) at:</strong> |
There was a problem hiding this comment.
should we also mention that it is published to NPM? And also having this nearfs link means we have to make sure to update it for every release. How do we automate that in a good way? Should we rather publish releases with a file pointing to the NEARFS link?
There was a problem hiding this comment.
This is a good idea.
Do we need the full web4 in the address or can we just do the cid?
And is it right to think this should go in package.json, like this?
"nearfs": { // or ipfs?
"cid": "..."
}
There was a problem hiding this comment.
@petersalomonsen pull request for this here: #39
petersalomonsen
approved these changes
Jul 14, 2024
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.
**Note: this includes changes from #39 **
Main modifications:
This is an ongoing pull request to update the documentation until next release.
Since we merged #27, we have full parity with near-social-vm -- and after we merge #26, we will be able to fully replace bos-workspace's gateway with a near-bos-webcomponent