-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Publish Crates, Npm Package and Usage Docs #21
Conversation
Codecov Report
@@ Coverage Diff @@
## main #21 +/- ##
==========================================
+ Coverage 79.91% 80.05% +0.13%
==========================================
Files 9 9
Lines 712 732 +20
==========================================
+ Hits 569 586 +17
- Misses 143 146 +3
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
8cb532b
to
f466363
Compare
de5b22e
to
e60649d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a comment about the wnfs
scripts (and generally some ideas around where to go from there with our builds scripts).
I think we should at least rename it, but other than that this is good to go!
Docs 🙌 ✨
README.md
Outdated
@@ -85,9 +180,9 @@ Its goal is to be as dependency-less as possible in order to be easily compiled | |||
|
|||
</details> | |||
|
|||
- **The _wnfs_ Helper Script** | |||
- **The _wnfs_ Command** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should rename the script in order to avoid confusion with a potential wnfs CLI that actually reads and writes WNFS similar to what the ipfs
CLI is doing today.
Or we could go for a Justfile
which is similar to a makefile, but simpler. We're using it in a lot of other places at fission.
And lastly we could go for a nix version, but that's way more involved to set up compared to a justfile.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was considering make but had issues with it in the past. Just looks like an improved make. I'm going to switch to it later.
I agree with renaming it. Maybe rs-wnfs
because it is specific to the repo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about build-wnfs.sh
? Or maybe make-wnfs
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rs-wnfs
fine too probably.
Summary
This PR implements the following features
This PR just prepares the project for package publishing (npm, doc.rs, crates.io). Also adds usage examples.
WNFS NPM package:
WNFS crates:
Examples of WNFS usage here:
JavaScript:
Rust:
Test plan (required)
N/A
Ongoing Issues
Closing issues
Fixes #22