mczochowski / rfcs-1

RFCs for the PayID Protocol in IETF format.

PayID

Specs

• You can find the full list of RFCs here

List of RFCs

• PayID Whitepaper
• The 'payid' URI Scheme
• PayID Discovery
• PayID Protocol
• Verifiable PayID Protocol

The source code for each spec is in src/spec.

Implementations

Known implementations of PayID and PayID Discovery:

• TypeScript
• Java: TBD.
• Swift: TBD.

If you would like to update this list, please feel free to open a pull request against this repository.

Generating the Spec

From the root directory of the repo run:

    # Install IETF RFC tools
    gem install kramdown-rfc2629
    pip3 install xml2rfc

    # Install PayID RFC dependencies
    npm install

    # Generate the spec
    npm run spec

This generates the RFC output files in the dist folder using kramdown-rfc2629, xml2rfc and Grunt with the Grunt kramdown_rfc2629 task

To watch edits to RFC source files and auto-generate output when changes are saved run npm run watch.

Authoring a new RFC

First, write a Pull Request that adds the markdown file for the spec in the src/spec folder.

Then, add that file to the Gruntfile list of RFCs. That way the spec output can be generated for your proposal.