Skip to content

Commit

Permalink
Update readmes and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
alessandro-fazzi committed Feb 1, 2021
1 parent bb7093d commit 6f4e9b6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 36 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Wordless is a junction between a WordPress plugin and a theme boilerplate that d
* Write PHP templates with [Pug templating system](https://github.com/pug-php/pug)
* Write CSS stylesheets using the awesome [SCSS syntax](http://sass-lang.com)
* Out-of-the-box support to [Stylelint](https://stylelint.io/) configured for SCSS syntax.
* Write Javascript logic in ES2015 thanks to [Babel](https://babeljs.io/)
* Write Javascript logic using modern syntax thanks to [Babel](https://babeljs.io/)
* Automatically polyfill (with [core-js](https://github.com/zloirock/core-js)) and transpile Javascript based on your support inside [`.browserslistrc`](https://github.com/browserslist/browserslist)
* A growing set of handy and documented PHP helper functions ready to be used within your views
* Preconfigured support to [MailHog](https://github.com/mailhog/MailHog) mail-catcher.
* Preconfigured support to [MailHog](https://github.com/mailhog/MailHog) mail-catcher in development.
* Development workflow backed by [WebPack](https://github.com/webpack/webpack), [BrowserSync](https://www.browsersync.io/) (with live reload), [WP-CLI](http://wp-cli.org/), [Yarn](https://yarnpkg.com/en/). All the standards you already know, all the customizations you may need.

[![Build Status](https://travis-ci.org/welaika/wordless.svg?branch=master)](http://travis-ci.org/welaika/wordless)
![Helpers tests](https://github.com/welaika/wordless/workflows/Test/badge.svg?branch=master)
[![Documentation Status](https://readthedocs.org/projects/wordless/badge/?version=latest)](https://wordless.readthedocs.io/en/latest/?badge=latest)

## Documentation
Expand Down
39 changes: 7 additions & 32 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,26 @@

Contributors: welaika, stefano.verna
Donate link: https://github.com/welaika/wordless
Tags: sass, pug, jade, webpack, scss, npm, yarn, babel, es6
Requires at least: 3.0
Tags: pug, webpack, scss, npm, yarn, babel, es6
Requires at least: 5.5.1
Tested up to: 5.6
Stable tag: 5.0.0-beta
Stable tag: 5.0.0
License: The MIT License
License URI: http://www.opensource.org/licenses/MIT

Wordless is an opinionated WordPress plugin that dramatically speeds up and enhances your custom theme creation. Some of its features are:
Wordless is a junction between a WordPress plugin and a theme boilerplate that dramatically speeds up and enhances your custom theme creation. Some of its features are:

* A structured, organized and clean [theme organization](https://github.com/welaika/wordless/tree/master/wordless/theme_builder/vanilla_theme)
* A structured, organized and clean [theme organization](https://wordless.readthedocs.io/en/latest/_pages/usage/anatomy.html)
* Bootstrap a new theme directly within wp-cli
* Write PHP templates with [Pug templating system](https://github.com/pug-php/pug)
* Write CSS stylesheets using the awesome [SCSS syntax](http://sass-lang.com)
* Out-of-the-box support to [Stylelint](https://stylelint.io/) configured for SCSS syntax.
* Write Javascript logic in ES2015 thanks to [Babel](https://babeljs.io/)
* Write Javascript logic using modern syntax thanks to [Babel](https://babeljs.io/)
* Automatically polyfill (with [core-js](https://github.com/zloirock/core-js)) and transpile Javascript based on your support inside [`.browserslistrc`](https://github.com/browserslist/browserslist)
* A growing set of handy and documented PHP helper functions ready to be used within your views
* Preconfigured support to [MailHog](https://github.com/mailhog/MailHog) mail-catcher.
* Preconfigured support to [MailHog](https://github.com/mailhog/MailHog) mail-catcher in development.
* Development workflow backed by [WebPack](https://github.com/webpack/webpack), [BrowserSync](https://www.browsersync.io/) (with live reload), [WP-CLI](http://wp-cli.org/), [Yarn](https://yarnpkg.com/en/). All the standards you already know, all the customizations you may need.

[![Build Status](https://travis-ci.org/welaika/wordless.svg?branch=master)](http://travis-ci.org/welaika/wordless)
[![Documentation Status](https://readthedocs.org/projects/wordless/badge/?version=latest)](https://wordless.readthedocs.io/en/latest/?badge=latest)

## Documentation

### Complete documentation
Expand All @@ -35,28 +32,6 @@ Read the complete Wordless documentation at [wordless.readthedocs.io](https://wo

You can find it at http://welaika.github.io/wordless/docs/latest/html/index.html.


== Changelog ==

You can find the changelog @ https://github.com/welaika/wordless/releases

== Upgrade Notice ==

= 3.0.0 =

* Haml is no longer supported
* This version of wordless is not compatible with theme structure from <3.0.0.
It's up to you to adapt your folders accordingly if you'd like to update the plugin.

= 2.6.1 =

Added helper for Gutenberg/ACF blocks.

= 2.5 =

* Old ruby preprocessors are no more activated by default. Please refer to
the changelog for more info.

= 0.5 =

* WARNING! Version 0.5 is not backward compatible! Wordless had always used `yield()` function in its template; starting from some point yield() become a reseved PHP function, so we had to rename it in Wordless code. If you get errors search and replace `yield()` inside the pugin directory with `wl_yield()`. Sorry for the inconvenient.
2 changes: 1 addition & 1 deletion wordless.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Plugin Name: Wordless
Plugin URI: https://github.com/welaika/wordless
Description: Wordless is framework which dramatically speeds up and enhances your custom themes creation, thanks to Sass, Pug, Coffeescript, ES6, Babel and Webpack.
Version: 5.0.0-beta
Version: 5.0.0
Author: weLaika
Author URI: http://welaika.com/
License: The MIT License
Expand Down

0 comments on commit 6f4e9b6

Please sign in to comment.