Skip to content

Commit

Permalink
Update readme for 2.2.7
Browse files Browse the repository at this point in the history
  • Loading branch information
seothemes committed Feb 9, 2018
1 parent 9bdebdf commit 6d74fd6
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 44 deletions.
24 changes: 7 additions & 17 deletions README.md
Expand Up @@ -5,7 +5,6 @@ A search engine optimized, mobile-first, flexbox-based starter theme for the Gen

![Screenshot](https://s3-us-west-1.amazonaws.com/seo-themes/screenshot.png)


## Features

#### Automation
Expand All @@ -15,9 +14,11 @@ A search engine optimized, mobile-first, flexbox-based starter theme for the Gen
* Combines CSS rules, selectors and media queries for the smallest minification possible
* Automatically optimizes PNG and JPG images
* Automatically translates theme into POT file
* Automatically minify JavaScript into min directory
* Automatically concatenate JavaScript files into single file
* Automatically minify JavaScript files
* Automatically adds _:focus_ rules after every _:hover_ rule
* Task for packaging theme into a distribution ZIP file
* Gulp task for packaging theme into a distribution ZIP file
* Gulp task for bumping theme version
* Helpful Sass/SCSS partials, variables, mixins and functions included
* Contains POT file for internationalization (i18n)

Expand All @@ -38,7 +39,7 @@ A search engine optimized, mobile-first, flexbox-based starter theme for the Gen
* Only loads WooCommerce styles on WooCommerce pages
* Uses Genesis Widget Column Classes for flexible layouts
* Built in support for [Simple Social Icons](https://en-au.wordpress.org/plugins/simple-social-icons/) and [Gravity Forms](http://www.gravityforms.com/) plugins
* Removes Gravity Forms and Simple Social Icons default stylesheets
* Removes Simple Social Icons default stylesheets
* Adds mobile-first, flexbox Gravity Forms and Simple Social Icons SCSS
* Includes workaround to allow for different styling on multiple Simple Social Icons widgets

Expand Down Expand Up @@ -90,7 +91,6 @@ A search engine optimized, mobile-first, flexbox-based starter theme for the Gen
* NPM > 5.6.0
* Gulp.js > 3.9


## Installation

1. Upload and install Genesis
Expand All @@ -100,7 +100,6 @@ A search engine optimized, mobile-first, flexbox-based starter theme for the Gen
5. Import sample.xml from Tools > Import
6. Import widgets.wie from Tools > Widget Importer & Exporter


## Renaming

The following instructions require the use of a text editor with search and replace functionality. You will need to perform a search and replace on all files in the theme folder. If using NPM, the theme should be renamed before running `npm install`. You do not want to edit any files in the `node_modules` directory.
Expand All @@ -111,7 +110,6 @@ The following instructions require the use of a text editor with search and repl

You can also use the Gulp [rename](#additional-commands) task included with the theme.


## Customization

1. Go to Appearance > Customize > Site Identity to upload a logo
Expand All @@ -121,7 +119,6 @@ You can also use the Gulp [rename](#additional-commands) task included with the
5. Go to Appearance > Customize > Site Layout and configure to your liking
6. Go to Genesis > Theme Settings to enable Breadcrumbs on pages


## Widget Areas

* Header right
Expand All @@ -130,7 +127,6 @@ You can also use the Gulp [rename](#additional-commands) task included with the
* Front page (default 5)
* Footer (default 3)


## Structure

```shell
Expand All @@ -151,7 +147,8 @@ theme/
│ ├── header.php
│ ├── helpers.php
│ ├── plugins.php
│ └── rgba.php
│ ├── rgba.php
│ └── widgets.php
├── languages/
│ └── genesis-starter.pot
├── templates/
Expand All @@ -175,7 +172,6 @@ theme/
└── widgets.wie
```


## Development

Genesis Starter uses [Gulp](http://gulpjs.com/) as a build tool and [npm](https://www.npmjs.com/) to manage front-end packages.
Expand All @@ -199,7 +195,6 @@ You now have all the necessary dependencies to run the build process.
* `gulp watch` — Compile assets when file changes are made, start Browsersync
* `gulp` — (Default task) runs all of the above tasks.


#### Additional commands

* `gulp translate` — Scan the theme and create `languages.pot` POT file.
Expand All @@ -212,7 +207,6 @@ You now have all the necessary dependencies to run the build process.
* `gulp rename` - Rename theme Title, Text Domain and Function Prefix.
- `--to` name for your theme e.g: `gulp rename --to your-theme-name`


### Using Browsersync

To use Browsersync you need to update the proxy URL in `gulpfile.js` to reflect your local development hostname.
Expand All @@ -227,24 +221,20 @@ If your local development URL is `my-site.dev`, update the file to read:

By default, BrowserSync is configured to use a HTTP connection. If you are using an SSL certificate for local development uncomment the HTTPS settings and change the proxy URL accordingly.


## Support

Please visit https://seothemes.com/support/ for theme support.


## Authors

- **Lee Anthony** - [SEO Themes](https://seothemes.com/)

See also the list of [contributors](https://github.com/seothemes/genesis-starter/graphs/contributors) who participated in this project.


## License

This project is licensed under the GNU General Public License - see the LICENSE.md file for details.


## Acknowledgments

A shout out to anyone who's code was used:
Expand Down
54 changes: 27 additions & 27 deletions gulpfile.js
Expand Up @@ -384,33 +384,6 @@ gulp.task('publish', function () {

});

/**
* Process tasks and reload browsers on file changes.
*
* https://www.npmjs.com/package/browser-sync
*/
gulp.task('watch', function () {

// HTTPS (optional).
browsersync({
proxy: 'http://genesis-starter.dev',
port: 8000,
notify: false,
open: false,
// https: {
// "key": "/Users/seothemes/.valet/Certificates/genesis-starter.dev.key",
// "cert": "/Users/seothemes/.valet/Certificates/genesis-starter.dev.crt"
// }
});

// Run tasks when files change.
gulp.watch(paths.styles, ['styles']);
gulp.watch(paths.scripts, ['scripts']);
gulp.watch(paths.images, ['images']);
gulp.watch(paths.php).on('change', browsersync.reload);

});

/**
* Rename theme.
*
Expand Down Expand Up @@ -486,6 +459,33 @@ gulp.task('bump', function () {

});

/**
* Process tasks and reload browsers on file changes.
*
* https://www.npmjs.com/package/browser-sync
*/
gulp.task('watch', function () {

// HTTPS (optional).
browsersync({
proxy: 'http://genesis-starter.dev',
port: 8000,
notify: false,
open: false,
// https: {
// "key": "/Users/seothemes/.valet/Certificates/genesis-starter.dev.key",
// "cert": "/Users/seothemes/.valet/Certificates/genesis-starter.dev.crt"
// }
});

// Run tasks when files change.
gulp.watch(paths.styles, ['styles']);
gulp.watch(paths.scripts, ['scripts']);
gulp.watch(paths.images, ['images']);
gulp.watch(paths.php).on('change', browsersync.reload);

});

/**
* Create default task.
*/
Expand Down

0 comments on commit 6d74fd6

Please sign in to comment.