Skip to content

Commit

Permalink
Update Cargo.toml and README
Browse files Browse the repository at this point in the history
  • Loading branch information
cramertj committed Jan 9, 2017
1 parent 3d39b74 commit 3136386
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
8 changes: 8 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ name = "domafic"
version = "0.1.0"
authors = ["Taylor Cramer <[email protected]>"]

license = "MIT/Apache-2.0"
repository = "https://github.com/cramertj/domafic-rs"
documentation = "https://docs.rs/domafic/0"

description = "A library for building safe, high-performance, universal web applications"

keywords = ["web", "ui", "javascript", "framework", "template"]

[dependencies]
either_n = { version = "0.2.0", optional = true }
libc = { version = "0.2.16", optional = true }
Expand Down
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
# domafic-rs
# Domafic - Safe, high-performance, universal web applications

[![Build Status](https://travis-ci.org/cramertj/domafic-rs.svg?branch=master)](https://travis-ci.org/cramertj/domafic-rs)
[![crates.io](https://img.shields.io/crates/v/domafic.svg)](https://crates.io/crates/domafic)

[Documentation](https://docs.rs/domafic)

## Installing Emscripten
Using Domafic in the browser requires Emscripten.
To get started with Emscripten, follow the steps detailed
[here.](https://users.rust-lang.org/t/compiling-to-the-web-with-rust-and-emscripten)

## Running the Examples
To try the examples in a browser, start by compiling the example to asm.js:
`cargo build --example todo_mvc --target=asmjs-unknown-emscripten`
If this is your first time compiling with Emscripten, this may take a while.
Once the example is built, open up `index_debug.html` (for debug builds) or
`index_release.html` (for release builds) and make sure the script `src` is
set to point at the example you want to run. From there it's as simple as
opening up your browser and trying it out!

0 comments on commit 3136386

Please sign in to comment.