Skip to content

Commit 5eceb33

Browse files
authored
Merge pull request #3 from indigotree/documentation
Added documentation for new Features
2 parents d0f6336 + d4f03e8 commit 5eceb33

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Atlas, Hugo Boilerplate](https://atlas.indigotree.co.uk/images/github-banner.png)
1+
[![Atlas, Hugo Boilerplate](https://atlas.indigotree.co.uk/images/github-banner.png)](https://github.com/indigotree/atlas)
22

33
![](http://forthebadge.com/images/badges/uses-badges.svg) ![](http://forthebadge.com/images/badges/built-by-developers.svg) ![](http://forthebadge.com/images/badges/gluten-free.svg)
44

@@ -8,6 +8,17 @@ The [Hugo](https://gohugo.io/) boilerplate we use for our projects.
88

99
**Disclaimer** - This boilerplate has been heavily integrated with [Netlify](https://www.netlify.com/), and therefore many features are specific to the Netlify platform and may not work with other hosting providers.
1010

11+
## Features
12+
13+
Atlas provides the following features out of the box:
14+
15+
* A set of [Gulp](/gulpfile.babel.js) tasks for SASS, Linting, ES2015, Image compression
16+
* Environment driven `robots.txt` file (disallows robots on everything other than production)
17+
* Base HTML templates with easy customisation/extension
18+
* [Configuration](/netlify.toml) for Netlify deployments
19+
* [Better defaults](#security-headers) for configuring HTTPS
20+
* [Better redirects](#redirects) with Netlify instead of `<meta http-equiv="refresh">`
21+
1122
## Getting Started
1223

1324
To get started, you can either clone the repository, or deploy straight to [Netlify](#deploy-to-netlify). Then run the following from the project root:

0 commit comments

Comments
 (0)