Get syntax highlighting in readme.

This commit is contained in:
Andrew Dirksen 2019-05-13 10:23:00 -07:00
parent cd7b218e51
commit 33e9c6c73f
3 changed files with 11 additions and 11 deletions

View file

@ -1,6 +1,6 @@
[package] [package]
name = "pow" name = "pow"
version = "0.1.3" version = "0.1.4"
authors = ["Andrew Dirksen <andrew@dirksen.com>"] authors = ["Andrew Dirksen <andrew@dirksen.com>"]
description = """ description = """
Generate or verify sha256 based proofs of work over arbitrary typed data. Generate or verify sha256 based proofs of work over arbitrary typed data.

View file

@ -8,7 +8,7 @@ Any type that implementes serde::Deserialize can be tagged with a proof of work.
Prove we did work targeting a phrase. Prove we did work targeting a phrase.
``` ```rust
use pow::Pow; use pow::Pow;
// very easy mode // very easy mode
@ -21,7 +21,7 @@ assert!(pw.score(&phrase).unwrap() >= difficulty);
Prove more difficult work. This time targeting a time. Prove more difficult work. This time targeting a time.
``` ```rust
// more diffcult, takes around 100_000 hashes to generate proof // more diffcult, takes around 100_000 hashes to generate proof
let difficulty = u128::max_value() - u128::max_value() / 100_000; let difficulty = u128::max_value() - u128::max_value() / 100_000;
@ -41,7 +41,7 @@ of work blockchains.
In other words: In other words:
``` ```rust
fn score<T: Serialize>(target: &T, pow_tag: &Pow<T>) -> u128 { fn score<T: Serialize>(target: &T, pow_tag: &Pow<T>) -> u128 {
let bytes = serialize(&SALT) + serialize(target) + serialize(pow_tag); let bytes = serialize(&SALT) + serialize(target) + serialize(pow_tag);
let hash = sha256(&bytes); let hash = sha256(&bytes);
@ -64,7 +64,7 @@ Difficulty settings are usually best adjusted dynamically a la bitcoin.
To manually select a difficulty, choose the average number of hashes required. To manually select a difficulty, choose the average number of hashes required.
``` ```rust
fn difficulty(average: u128) -> u128 { fn difficulty(average: u128) -> u128 {
debug_assert_ne!(average, 0, "It is impossible to prove work in zero attempts."); debug_assert_ne!(average, 0, "It is impossible to prove work in zero attempts.");
let m = u128::max_value(); let m = u128::max_value();
@ -75,7 +75,7 @@ fn difficulty(average: u128) -> u128 {
Conversely, to calculate probable number of hashes required to satisfy a given minimum Conversely, to calculate probable number of hashes required to satisfy a given minimum
difficulty. difficulty.
``` ```rust
fn average(difficulty: u128) -> u128 { fn average(difficulty: u128) -> u128 {
let m = u128::max_value(); let m = u128::max_value();
if difficulty == m { if difficulty == m {

View file

@ -6,7 +6,7 @@
//! //!
//! Prove we did work targeting a phrase. //! Prove we did work targeting a phrase.
//! //!
//! ``` //! ```rust
//! use pow::Pow; //! use pow::Pow;
//! //!
//! // very easy mode //! // very easy mode
@ -19,7 +19,7 @@
//! //!
//! Prove more difficult work. This time targeting a time. //! Prove more difficult work. This time targeting a time.
//! //!
//! ``` //! ```rust
//! # fn get_unix_time_seconds() -> u64 { //! # fn get_unix_time_seconds() -> u64 {
//! # use std::time::{Duration, SystemTime}; //! # use std::time::{Duration, SystemTime};
//! # SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs() //! # SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs()
@ -45,7 +45,7 @@
//! //!
//! In other words: //! In other words:
//! //!
//! ``` //! ```rust
//! # use serde::Serialize; //! # use serde::Serialize;
//! # use pow::Pow; //! # use pow::Pow;
//! # use core::any::Any; //! # use core::any::Any;
@ -75,7 +75,7 @@
//! //!
//! To manually select a difficulty, choose the average number of hashes required. //! To manually select a difficulty, choose the average number of hashes required.
//! //!
//! ``` //! ```rust
//! fn difficulty(average: u128) -> u128 { //! fn difficulty(average: u128) -> u128 {
//! debug_assert_ne!(average, 0, "It is impossible to prove work in zero attempts."); //! debug_assert_ne!(average, 0, "It is impossible to prove work in zero attempts.");
//! let m = u128::max_value(); //! let m = u128::max_value();
@ -86,7 +86,7 @@
//! Conversely, to calculate probable number of hashes required to satisfy a given minimum //! Conversely, to calculate probable number of hashes required to satisfy a given minimum
//! difficulty. //! difficulty.
//! //!
//! ``` //! ```rust
//! fn average(difficulty: u128) -> u128 { //! fn average(difficulty: u128) -> u128 {
//! let m = u128::max_value(); //! let m = u128::max_value();
//! if difficulty == m { //! if difficulty == m {