Overhaul of readme

README.md

@@ -1,14 +1,21 @@
-bigprimes.net
-======
+# bigprimes.net
 
-Serverless Rust with Web Assmebly.
+<img align="right" border="1" src="./assets/screen-capture.gif" height="200" />
 
-[![Rust](https://img.shields.io/badge/Rust%20%3E%3D%201.36-000.svg?style=flat-square&logo=rust&colorA=ffffff&style=popout)](https://rust-lang.org/)
+[![Rust](https://img.shields.io/badge/Rust%20%3E%3D%201.76-000.svg?style=flat-square&logo=rust&colorA=000000&style=popout)](https://rust-lang.org/)
 [![Build Status](https://github.com/craigmayhew/bigprimes.net/workflows/Rust/badge.svg)](https://github.com/craigmayhew/bigprimes.net/actions)
 
-Setup your local dev environment
-===
+A single page web app, written exclusively in rust and compiled to WebAssembly.
+
+## Contributing
+Contributions are very welcome in the form of PRs. If it's a big contribution I recommend contacting me first and we can make sure it's aligned to the project direction. 
+ 1. Write code
+ 2. Run tests `cargo test` and check nothing is broken
+ 3. Add/run benchmarks `cargo bench` and check nothing is terribly slow
+ 4. `cargo fmt --all` to format code contributions.
+ 5. Create PR
 
+### Setup your local dev environment
  1. Clone bigprimes.net `git clone https://github.com/craigmayhew/bigprimes.net.git`
  2. Install cargo rustc, rustup `curl https://sh.rustup.rs -sSf | sh`
  3. Install wasm-pack `curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh`
@@ -17,23 +24,13 @@ Setup your local dev environment
  6. Build `trunk build`
  7. Build, serve and rebuild on changes `trunk serve --open`
 
-Contributing
-===
+### Design patterns
+BigPrimes uses the [Seed](https://github.com/seed-rs/seed) framework. Seed is inspired by [Elm](https://en.wikipedia.org/wiki/Elm_(programming_language)) and so uses the model-view-update (MVU) architecture.
 
- 1. Write code
- 2. Run tests
- 3. Create PR
-
-Build
-===
+### Build
 
  - Build: `wasm-pack build` or `trunk build`
  - Build and serve locally: `trunk serve --open`
-
-Fun Facts
-===
-- there are 1.4\*10<sup>297</sup> primes smaller than 300 digits
-- there is always a prime between n^2 and (n+1)^2.
 
 Thanks
 ===