Update README.md

This commit is contained in:
Ludwig Schubert
2018-03-30 11:33:42 -07:00
committed by GitHub
parent 22d196c5c9
commit 90543f80a4
+15 -15
View File
@@ -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
<script src="http://distill.pub/template.v1.js"></script>
```
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).