diff --git a/README.md b/README.md new file mode 100644 index 0000000..7ba012f --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +
+ + Fission-Cli Logo + + +

Fission-Cli

+ +

+ + + License-Apache + + + Discord + + + Discourse + +

+
+ +## + +### In Progress Notice +This repository is a rewrite of our current Cli that can be found [here](https://github.com/fission-codes/fission/tree/main/fission-cli). The progress we are making toward finishing the rewrite can be seen on [this tracking issue](https://github.com/fission-codes/fission-cli/issues/1). However, our plan is to wrap the existing binary so that the application be used even while the rewrite is still in progress. + +### What does it do? +This CLI allows a user to publish front-end webapps to IPFS and view it an easy way. + +#### How Do I use it? +Take a look at our [getting started](https://guide.fission.codes/developers/getting-started) page for more information. + + +### Contributing +Check out our [contibuting guide](./CONTRIBUTING.md) for more info surrounding how to contribute to this project. + +### Working from Source + +#### Dependancies +The only dependancy is [Rust](https://www.rust-lang.org/). + +#### Build from Source +`cargo run` or `cargo build` if you want to build without running it + +#### Run Tests +`cargo test` or `cargo test -- --nocapture` if you want to see the console outputs of the tests \ No newline at end of file diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..3bb0c69 Binary files /dev/null and b/assets/logo.png differ