Create README.md #31
Create README.md #31
Conversation
There was a problem hiding this comment.
This documentation is great.
I wonder if it should be in the `rpc' package, which doesn't have a README right now. All the examples do use rpc. And that way it will appear on NPM https://www.npmjs.com/package/@agoric/rpc
Maybe root has "UI KIt" and "Setup" and pointers to each package README which have the snippets.
That other README could be part of the PR publishing rpc 0.5.0. So this PR can stay as is until that's in main
README.md
Outdated
|
|
||
| *package.json:* | ||
| ``` | ||
| "@agoric/rpc": "^0.4.1-dev-7cf64bb.0" |
There was a problem hiding this comment.
let's not point to dev versions in the repo README. until we publish 0.5.0 we can tell partners to use this dev version.
The readme can have yarn add @agoric/rpc. Or leave it out since it's pretty obvious.
README.md
Outdated
| *package.json:* | ||
| ``` | ||
| "@agoric/notifier": "^0.6.2", | ||
| "@agoric/rpc": "^0.4.1-dev-7cf64bb.0", | ||
| "@agoric/web-components": "0.10.1-dev-7cf64bb.0" | ||
| ``` |
There was a problem hiding this comment.
ditto, most readers of the README shouldn't need these version numbers.
for simplicity we could just hold off on merging this PR until we've published these versions as full releases.
| AgoricChainStoragePathKind as Kind | ||
| } from '@agoric/rpc'; | ||
|
|
||
| const watcher = makeAgoricChainStorageWatcher(rpc, chainName); |
There was a problem hiding this comment.
I'm used to passing network access (fetch) in explicitly. I don't expect to change that here, but it's worth indexing under Agoric/agoric-sdk#2160
samsiegart
force-pushed
the
samsiegart-patch-1
branch
3 times, most recently
from
c49d291
to
cb711ad
Compare
|
@turadg I removed the dev npm versions and added some smaller snippets under the packages themselves. PTAL |
No description provided.