m/portfolio
1
0
Fork 0
mirror of https://github.com/kremalicious/portfolio.git synced 2025-01-03 18:35:00 +01:00
Code Releases Activity

docs update

Browse Source
This commit is contained in:
Matthias Kretschmann 2018-06-23 14:49:40 +02:00
parent fef6268510
commit 1166d86c89
Signed by: m
GPG Key ID: 606EEEF3C479A91F
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -15,19 +15,19 @@
## Table of Contents ## Table of Contents
* [Features](#features) - [Features](#features)
* [One data file to rule all pages](#one-data-file-to-rule-all-pages) - [One data file to rule all pages](#one-data-file-to-rule-all-pages)
* [Theme switcher](#theme-switcher) - [Theme switcher](#theme-switcher)
* [SEO component](#seo-component) - [SEO component](#seo-component)
* [Client-side vCard creation](#client-side-vcard-creation) - [Client-side vCard creation](#client-side-vcard-creation)
* [Matomo (formerly Piwik) analytics tracking](#matomo-formerly-piwik-analytics-tracking) - [Matomo (formerly Piwik) analytics tracking](#matomo-formerly-piwik-analytics-tracking)
* [Project images](#project-images) - [Project images](#project-images)
* [Importing SVG assets](#importing-svg-assets) - [Importing SVG assets](#importing-svg-assets)
* [Development](#development) - [Development](#development)
* [Linting](#linting) - [Linting](#linting)
* [Add a new project](#add-a-new-project) - [Add a new project](#add-a-new-project)
* [Deployment](#deployment) - [Deployment](#deployment)
* [Licenses](#licenses) - [Licenses](#licenses)
--- ---
@ -79,10 +79,10 @@ All project images use one single component defined in [`src/components/atoms/Pr
### Importing SVG assets ### Importing SVG assets
Makes use of `gatsby-plugin-svgr` so SVG assets can be imported like so: All SVG assets under `src/images/` will be converted to React components before every build. Makes use of `SVGR` so SVG assets can be imported like so:
```js ```js
import { ReactComponent as Logo } from '../images/logo.svg' import Logo from './components/svg/Logo'
``` ```
## Development ## Development
@ -133,8 +133,8 @@ portfolio-SLUG-03.png
Automatic deployments are triggered upon successful tests & builds on Travis: Automatic deployments are triggered upon successful tests & builds on Travis:
* push to `master` initiates a live deployment - push to `master` initiates a live deployment
* any Pull Request, and subsequent pushes to it, initiates a beta deployment - any Pull Request, and subsequent pushes to it, initiates a beta deployment
The deploy command simply calls the [`scripts/deploy.sh`](scripts/deploy.sh) script, syncing the contents of the `public/` folder to S3: The deploy command simply calls the [`scripts/deploy.sh`](scripts/deploy.sh) script, syncing the contents of the `public/` folder to S3: