Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
iruzevic committed Jan 27, 2020
1 parent 119f550 commit 8e1ff52
Show file tree
Hide file tree
Showing 6 changed files with 9,198 additions and 1,371 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a

*No documentation available about unreleased changes as of yet.*

## [4.0.6] - 2020-01-27

### Changed
- Eightshift-frontend-libs update
- Eightshift-libs update
- Fixing readme.

## [4.0.5] - 2020-01-23
### Changed
- Readme Fix
Expand Down Expand Up @@ -200,6 +207,7 @@ Initial tagged release.

[Unreleased]: https://github.com/infinum/eightshift-boilerplate/compare/master...HEAD

[4.0.6]: https://github.com/infinum/eightshift-boilerplate/compare/4.0.5...v4.0.6
[4.0.5]: https://github.com/infinum/eightshift-boilerplate/compare/4.0.4...v4.0.5
[4.0.4]: https://github.com/infinum/eightshift-boilerplate/compare/4.0.3...v4.0.4
[4.0.3]: https://github.com/infinum/eightshift-boilerplate/compare/4.0.2...v4.0.3
Expand Down
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,13 @@ This repository contains all the tools you need to start building a modern WordP
## :books: Table of contents
- [:mortar_board: Documentation](#mortar_board-documentation)
- [:tada: Awesome features](#tada-awesome-features)
- [:school_satchel: Requirements](#school_satchel-requirements)
- [:rocket: Quick start](#rocket-quick-start)
- [:interrobang: Plugin](#interrobang-plugin)
- [:mailbox: Who do I talk to?](#mailbox-who-do-i-talk-to)
- [:scroll: License](#scroll-license)

## :mortar_board: Documentaiton
Eightshift Boilerplate uses 2 libraries depending on the technology. We have specific documentation for each library.

[Eightshift Frontend Lib](https://github.com/infinum/eightshift-frontend-libs) is used for all frontend related parts like JavaScript, Scss, Webpack, Babel, Storybook, linting, etc. You can find the **[documentation here](https://infinum.github.io/eightshift-frontend-libs/)**.

[Eightshift Lib](https://github.com/infinum/eightshift-libs) is used for all backend related parts for WordPress using Php technology. You can find the **[documentation here](https://infinum.github.io/eightshift-libs/)**.
**For more documentation details follow [this link](https://infinum.github.io/eightshift-docs).**

## :tada: Awesome features

Expand All @@ -46,9 +42,32 @@ Here's why you should use Eightshift Boilerplate for your next project.
- **[Eightshift Libs](https://github.com/infinum/eightshift-libs)** - Library aimed at bringing the modern development tools to your project.
- **[Eightshift Frontend Libs](https://github.com/infinum/eightshift-frontend-libs)** - A collection of useful frontend utility modules and all the tools you need to start building a modern Gutenberg dynamic blocks.

## :school_satchel: Requirements

1. [Node.js](https://nodejs.org/en/)
2. [Composer](https://getcomposer.org/)

## :rocket: Quick start
Let's create a new project!

Navigate to your WordPress theme folder and run the following command:

```
npx create-wp-project
```

Script will prompt you for theme name and local development url (used for BrowserSync) and install a new theme:

![](https://raw.githubusercontent.com/infinum/eightshift-frontend-libs/develop/package/setup.gif)

After the script is finished, you can activate the theme through WP Admin Dashboard.

To start developing run this command from projects root folder:
```
npm start
```

Let's create a new project! Follow [this link](https://github.com/infinum/eightshift-boilerplate/wiki) to see how it is done.
**For more instalation details follow [this link](https://infinum.github.io/eightshift-docs).**

## :mailbox: Who do I talk to?

Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
},
"require": {
"php": ">=7.1",
"infinum/eightshift-libs": "^2.0.5"
"infinum/eightshift-libs": "^2.0.6"
},
"autoload": {
"classmap": [
Expand Down
12 changes: 6 additions & 6 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 8e1ff52

Please sign in to comment.