From 90543f80a4001b6eb9f6d30e3fe7f061100b3536 Mon Sep 17 00:00:00 2001 From: Ludwig Schubert Date: Fri, 30 Mar 2018 11:33:42 -0700 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 1d965a3..4c7c185 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -# Distill Template [![Build Status](https://travis-ci.org/distillpub/template.svg?branch=master)](https://travis-ci.org/distillpub/template) +# Distill Template -This is the repository for the distill web framework. If you're interesting in just using the framework to write an article for the [Distill journal](http://distill.pub), visit http://distill.pub/guide/. +This is the repository for the Distill web framework. -The general process for using this framework is to hotlink the compiled code in your dev environment. +## Contributing -```html - -``` -You can also install it as a local dependency through npm or with [yarn](https://yarnpkg.com). +To give feedback, report a bug, or request a feature, please open an issue. -``` -npm install --D distill-template -``` +To contribute a change, [check out the contributing guide](CONTRIBUTING.md). -If you're interested in submitting pull requests or developing on the framework itself, read on. +### Local Development -## Development +Run `npm run start` to start a watching build rollup server. To view the sample pages in the repo, you can run `npm run serve` as a separate process which starts a static server. `npm run build` will run a one-time build. -Run `yarn start` to start a watching build rollup server. To view the sample pages in the repo, you can run `yarn serve` as a separate process which starts a static server. `yarn build` will run a one-time build. -## Testing +## Disclaimer & License -Run `yarn test`. That's it. +_This project is research code. It is not an official product of Google or any other institution supporting Distill._ + +Copyright 2018, The Distill Template Authors. + +Licensed under the Apache License, Version 2.0 + +See the [full license](LICENSE).