Skip to content

Commit

Permalink
Release 0.8 (#263)
Browse files Browse the repository at this point in the history
* Making ES6 feature more prominent and some minor edits

* Adding info about Performance class

* Updating version number to 0.8.0

* Clarifying info about using get_field
  • Loading branch information
luboskmetko authored Sep 21, 2017
1 parent 46f631f commit 829c47b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ Chisel allows to create 2 projects types - front-end and WordPress projects with
- [Twig](http://twig.sensiolabs.org/) templating engine
- SCSS with [ITCSS architecture](https://www.xfive.co/blog/itcss-scalable-maintainable-css-architecture/)
- [Browserify](http://browserify.org/) with Watchify
- ES6 with [Babel](https://babeljs.io/)
- [gulp-rev](https://github.com/sindresorhus/gulp-rev) support
- [stylelint](http://stylelint.io/)
- [ESLint](http://eslint.org/)
- HTML validation with [htmlhint](https://github.com/bezoerb/gulp-htmlhint)
- optional ES2015 with [Babel](https://babeljs.io/)
- optional jQuery

### WordPress projects
Expand Down Expand Up @@ -251,7 +251,7 @@ File structure in WordPress projects is almost identical to the front-end projec

- **~~dist~~** - dist folder is moved to the theme folder (see below)
- **src**
- **~~templates~~** - templates are stored in the templates directory inside the theme directory because they are interpreted dynamically by WordPress and Timber, not build by Gulp like in non-WP projects
- **~~templates~~** - templates are stored in the templates directory inside the theme directory because they are interpreted dynamically by WordPress and Timber, not built by Gulp like in non-WP projects
- **~~index~~** - project index files are not used
- ~~index.html~~ - project index is not used
- **wp** - WordPress installation
Expand Down Expand Up @@ -410,7 +410,7 @@ So, to recap:
1. Make sure to you've got jQuery installed.
2. Place the plugin script inside `src/scripts/vendor.json`.
3. Add its name inside `src/scripts/vendor.json`.
4. Enjoy. ;)
4. Enjoy ;)

##### Notes

Expand Down Expand Up @@ -472,9 +472,7 @@ Classes you can work with:

- `\Chisel\WpExtensions` - use this class to extend Wordpress (register post types, taxonomies, etc.)
- `\Chisel\Security` - default security settings for Chisel, you can change or extend security settings here.

Classes you usually don't have to touch:

- `\Chisel\Performance` - class for optimizing performance, allows to setup which JS scripts should be deferred or asynced
- `\Chisel\Site` - this class extends `\Timber\Site` class and is used to setup whole site
- `\Chisel\Post` - this class extends `\Timber\Post` class
- `\Chisel\TwigExtensions` - this class is used to extend Twig
Expand Down Expand Up @@ -532,7 +530,7 @@ Refer to [Timber](http://upstatement.com/timber/) documentation if you are new t

#### Good practices

* Try to always use `get_field` method of `Chisel\Post` instead of direct call to the field:
* When using ACF try to always use `get_field` method of `Chisel\Post` instead of direct call to the field:

Good:
```html
Expand All @@ -544,6 +542,8 @@ Refer to [Timber](http://upstatement.com/timber/) documentation if you are new t
{{ post.field_name }}
```

Read more on the topic in [ACF Cookbook](https://timber.github.io/docs/guides/acf-cookbook/)

#### Security

In addition to default security settings you can also:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generator-chisel",
"version": "0.7.1",
"version": "0.8.0",
"description": "A Yeoman generator for scaffolding front-end and WordPress projects",
"homepage": "",
"author": {
Expand Down

0 comments on commit 829c47b

Please sign in to comment.