Update readme and contributing
parent
52b0b00fa3
commit
e248a78401
|
@ -1,31 +0,0 @@
|
|||
# Contributing
|
||||
|
||||
> **Contributions are welcome!** Here's how you can help. :raised_hands:
|
||||
|
||||
<p align="center">
|
||||
<b><a href="#code">Code</a></b>
|
||||
·
|
||||
<b><a href="#something-else">Something else</a></b>
|
||||
·
|
||||
<b><a href="#additional-notes">Additional notes</a></b>
|
||||
</p>
|
||||
|
||||
## Code
|
||||
|
||||
1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository and [clone](https://help.github.com/articles/cloning-a-repository/) your fork.
|
||||
2. Start editing!
|
||||
- Please follow the [HTML styleguide](#html-styleguide).
|
||||
3. Commit & [push](https://help.github.com/articles/pushing-to-a-remote/) your changes to a new branch.
|
||||
4. Once you're happy with your changes, [create a pull request](https://help.github.com/articles/creating-a-pull-request/).
|
||||
|
||||
## Something else
|
||||
|
||||
Questions, feedback & ideas are all welcome - just [open an issue](https://github.com/davisonio/davison.io/issues)! :smile:
|
||||
|
||||
Alternatively you can [contact the authors](https://github.com/davisonio/davison.io#authors).
|
||||
|
||||
## Additional notes
|
||||
|
||||
### HTML styleguide
|
||||
|
||||
- Ensure there are no significant problematic errors when running the webpage through the [validator](https://validator.w3.org/nu/).
|
39
README.md
39
README.md
|
@ -1,39 +0,0 @@
|
|||
# [davison.io](https://davison.io/davison.io/) :globe_with_meridians: [![](https://img.shields.io/travis/davisonio/davison.io.svg?style=flat-square)](https://travis-ci.org/davisonio/davison.io) [![](https://img.shields.io/gitter/room/davisonio/davison.io.svg)](https://gitter.im/davisonio/davison.io)
|
||||
|
||||
> Craig Davison's website @ [davison.io](https://davison.io)
|
||||
|
||||
<p align="center">
|
||||
<b><a href="#authors">Authors</a></b>
|
||||
·
|
||||
<b><a href="#license--credits">License & Credits</a></b>
|
||||
</p>
|
||||
|
||||
Here's the source code of my website which you can find on the interwebs over at [davison.io](https://davison.io).
|
||||
|
||||
Using [Jekyll](https://jekyllrb.com) and [Almace Scaffolding](https://sparanoid.com/lab/amsf/)!
|
||||
|
||||
![](https://davison.io/assets/img/davison-io-index.png)
|
||||
|
||||
## Authors
|
||||
|
||||
**[Craig Davison](https://davison.io)**
|
||||
|
||||
[![](https://img.shields.io/github/followers/davisonio.svg?style=social&label=Follow%20davisonio)](https://github.com/davisonio) [![](https://img.shields.io/twitter/follow/davisonio.svg?style=social)](https://twitter.com/davisonio)
|
||||
|
||||
With many thanks to the [contributors](https://github.com/davisonio/davison.io/graphs/contributors). :clap:
|
||||
|
||||
**Contributions are welcome!** Check out the [Contributing Guidelines](https://github.com/davisonio/davison.io/blob/master/CONTRIBUTING.md). :raised_hands:
|
||||
|
||||
## License & Credits
|
||||
|
||||
Unless otherwise stated:
|
||||
|
||||
- Copyright © 2015+ [Craig Davison](https://davison.io). Released under the [MIT License](http://davisonio.mit-license.org/2015).
|
||||
|
||||
[`assets/css/amsf.css`](https://github.com/davisonio/davison.io/blob/master/assets/css/amsf.css)
|
||||
|
||||
- Copyright © 2017 [Sparanoid, Inc](https://sparanoid.com). Released under the [MIT License](https://github.com/sparanoid/almace-scaffolding/blob/master/LICENSE).
|
||||
|
||||
[`assets/css/github-markdown.css`](https://github.com/davisonio/davison.io/blob/master/assets/css/github-markdown.css)
|
||||
|
||||
- Copyright © [Sindre Sorhus](https://sindresorhus.com). Released under the [MIT License](https://github.com/sindresorhus/github-markdown-css/blob/gh-pages/license).
|
|
@ -0,0 +1 @@
|
|||
# Contributing
|
|
@ -0,0 +1,29 @@
|
|||
# davison.io
|
||||
|
||||
> Craig Davison's website @ [davison.io](https://davison.io)
|
||||
|
||||
Here's the source code of my website which you can find at [davison.io](https://davison.io).
|
||||
|
||||
Blog is powered by [Ghost](https://ghost.org). Static pages are generated by [Jekyll](https://jekyllrb.com).
|
||||
|
||||
## Install
|
||||
|
||||
Install plugins:
|
||||
```
|
||||
gem install jekyll-sitemap
|
||||
```
|
||||
|
||||
## Credits
|
||||
|
||||
**[Craig Davison](https://davison.io)**
|
||||
|
||||
[![GitHub](https://img.shields.io/github/followers/davisonio.svg?style=social&label=Follow%20@davisonio)](https://github.com/davisonio) [![Twitter](https://img.shields.io/twitter/follow/davisonio.svg?style=social)](https://twitter.com/davisonio)
|
||||
|
||||
...and [contributors](https://github.com/davisonio/davison.io/graphs/contributors).
|
||||
|
||||
**[Contributions are welcome!](https://github.com/davisonio/davison.io/blob/master/contributing.md)**
|
||||
|
||||
## License
|
||||
|
||||
Unless otherwise stated:
|
||||
- Copyright © 2015+ [Craig Davison](https://davison.io).
|
Loading…
Reference in New Issue