Skip to content

Commit

Permalink
Add build, installation, contact, and branch information to the READM…
Browse files Browse the repository at this point in the history
…E.md (#67)
  • Loading branch information
jcjones committed Apr 7, 2016
1 parent deb5041 commit 3cadb96
Showing 1 changed file with 34 additions and 3 deletions.
37 changes: 34 additions & 3 deletions README.md
@@ -1,5 +1,36 @@

# Specification 'webauthn'
# Web Authentication Specification

This is the repository for the W3C WebAuthn Working Group, producing the draft **"Web Authentication"**

* [The editor's copy is available at https://w3c.github.io/webauthn/](https://w3c.github.io/webauthn/), or in the [`gh-pages` branch of this repository](https://github.com/w3c/webauthn/blob/gh-pages/index.html).
* [The build history is available at Travis-CI.org](https://travis-ci.org/w3c/webauthn/builds)
* [W3C WebAuthn Blog](https://www.w3.org/blog/webauthn/)

# Contributing

Before submitting feedback, please familiarize yourself with [our current issues list](https://github.com/w3c/webauthn/issues) and review the [mailing list discussion](https://lists.w3.org/Archives/Public/public-webauthn/).

# Building the Draft

Formatted HTML for the draft can be built using `make` or `gmake`:

```
$ make
```

# Installation and Setup

You will need to have the Python tools `pygments` and `bikeshed` to build the draft. Pygments can be obtained via `pip`, but Bikeshed will need to be downloaded with `git`:

```
git clone --depth=1 --branch=master https://github.com/tabatkins/bikeshed.git ./bikeshed
pip install pygments
pip install --editable ./bikeshed
bikeshed update
````

# Continuous Integration & Branches

This repository uses a [variation](https://github.com/jcjones/bikeshed-template) on [martinthomson/i-d-template](https://github.com/martinthomson/i-d-template) to generate the Editor's Draft on the `gh-pages` branch upon every merge to `master`. In order to prevent failed merges during continuous integration, the formatted Editor's Draft should not be checked in to `master`, and it is in the `.gitignore` file.

This is the repository for webauthn. You're welcome to contribute! Let's make the Web rock our socks
off!

0 comments on commit 3cadb96

Please sign in to comment.