Skip to content

Commit 46e0a84

Browse files
authored
📝 Update README [ci skip]
1 parent 41c7f2c commit 46e0a84

File tree

1 file changed

+20
-100
lines changed

1 file changed

+20
-100
lines changed

README.md

Lines changed: 20 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -5,130 +5,50 @@
55
</p>
66

77
<p align="center">
8-
<a href="LICENSE.md">
9-
<img alt="MIT License" src="https://img.shields.io/github/license/roots/sage?color=%23525ddc&style=flat-square" />
10-
</a>
11-
128
<a href="https://packagist.org/packages/roots/sage">
13-
<img alt="Packagist" src="https://img.shields.io/packagist/v/roots/sage.svg?style=flat-square" />
9+
<img alt="Packagist Installs" src="https://img.shields.io/packagist/dt/roots/sage?label=projects%20created&colorB=2b3072&colorA=525ddc&style=flat-square">
1410
</a>
1511

16-
<a href="https://github.com/roots/sage/actions">
17-
<img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/roots/sage/main.yml?branch=master&style=flat-square" />
12+
<a href="https://github.com/roots/sage/actions/workflows/main.yml">
13+
<img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/roots/sage/main.yml?branch=main&logo=github&label=CI&style=flat-square">
1814
</a>
1915

2016
<a href="https://twitter.com/rootswp">
21-
<img alt="Follow Roots" src="https://img.shields.io/twitter/follow/rootswp.svg?style=flat-square&color=1da1f2" />
17+
<img alt="Follow Roots" src="https://img.shields.io/badge/follow%20@rootswp-1da1f2?logo=twitter&logoColor=ffffff&message=&style=flat-square">
2218
</a>
2319
</p>
2420

25-
<p align="center">
26-
<strong>WordPress starter theme with Laravel Blade components and templates, Tailwind CSS, and a modern development workflow</strong>
27-
</p>
21+
<p align="center">Advanced WordPress starter theme with Tailwind CSS and Laravel Blade</p>
2822

2923
<p align="center">
30-
<a href="https://roots.io/"><strong><code>Website</code></strong></a> &nbsp;&nbsp; <a href="https://roots.io/sage/docs/installation/"><strong><code>Documentation</code></strong></a> &nbsp;&nbsp; <a href="https://github.com/roots/sage/releases"><strong><code>Releases</code></strong></a> &nbsp;&nbsp; <a href="https://discourse.roots.io/"><strong><code>Support</code></strong></a>
24+
<a href="https://roots.io/sage/">Website</a> &nbsp;&nbsp; <a href="https://roots.io/sage/docs/installation/">Documentation</a> &nbsp;&nbsp; <a href="https://github.com/roots/sage/releases">Releases</a> &nbsp;&nbsp; <a href="https://discourse.roots.io/">Community</a>
3125
</p>
3226

3327
## Sponsors
3428

35-
**Sage** is an open source project and completely free to use.
36-
37-
However, the amount of effort needed to maintain and develop new features and products within the Roots ecosystem is not sustainable without proper financial backing. If you have the capability, please consider [sponsoring Roots](https://github.com/sponsors/roots).
38-
39-
<p align="center"><a href="https://github.com/sponsors/roots"><img height="32" src="https://img.shields.io/badge/sponsor%20roots-525ddc?logo=github&logoColor=ffffff&message=" alt="Sponsor Roots"></a></p>
29+
Sage is an open source project and completely free to use. If you've benefited from our projects and would like to support our future endeavors, please consider [sponsoring Roots](https://github.com/sponsors/roots).
4030

4131
<div align="center">
42-
<a href="https://k-m.com/"><img src="https://cdn.roots.io/app/uploads/km-digital.svg" alt="KM Digital" width="148" height="111"></a> <a href="https://carrot.com/"><img src="https://cdn.roots.io/app/uploads/carrot.svg" alt="Carrot" width="148" height="111"></a> <a href="https://wordpress.com/"><img src="https://cdn.roots.io/app/uploads/wordpress.svg" alt="WordPress.com" width="148" height="111"></a> <a href="https://pantheon.io/"><img src="https://cdn.roots.io/app/uploads/pantheon.svg" alt="Pantheon" width="148" height="111"></a> <a href="https://worksitesafety.ca/careers/"><img src="https://cdn.roots.io/app/uploads/worksite-safety.svg" alt="Worksite Safety" width="148" height="111"></a> <a href="https://www.copiadigital.com/"><img src="https://cdn.roots.io/app/uploads/copia-digital.svg" alt="Copia Digital" width="148" height="111"></a> <a href="https://generodigital.com/"><img src="https://cdn.roots.io/app/uploads/genero.svg" alt="Genero" width="148" height="111"></a> <a href="https://40q.agency/"><img src="https://cdn.roots.io/app/uploads/40q.svg" alt="40Q" width="148" height="111"></a> <a href="https://jobpress.io/"><img src="https://cdn.roots.io/app/uploads/jobpress.png" alt="JobPress" width="148" height="111"></a>
32+
<a href="https://k-m.com/"><img src="https://cdn.roots.io/app/uploads/km-digital.svg" alt="KM Digital" width="120" height="90"></a> <a href="https://carrot.com/"><img src="https://cdn.roots.io/app/uploads/carrot.svg" alt="Carrot" width="120" height="90"></a> <a href="https://wordpress.com/"><img src="https://cdn.roots.io/app/uploads/wordpress.svg" alt="WordPress.com" width="120" height="90"></a> <a href="https://pantheon.io/"><img src="https://cdn.roots.io/app/uploads/pantheon.svg" alt="Pantheon" width="120" height="90"></a> <a href="https://worksitesafety.ca/careers/"><img src="https://cdn.roots.io/app/uploads/worksite-safety.svg" alt="Worksite Safety" width="120" height="90"></a> <a href="https://www.copiadigital.com/"><img src="https://cdn.roots.io/app/uploads/copia-digital.svg" alt="Copia Digital" width="120" height="90"></a> <a href="https://generodigital.com/"><img src="https://cdn.roots.io/app/uploads/genero.svg" alt="Genero" width="120" height="90"></a> <a href="https://40q.agency/"><img src="https://cdn.roots.io/app/uploads/40q.svg" alt="40Q" width="120" height="90"></a> <a href="https://jobpress.io/"><img src="https://cdn.roots.io/app/uploads/jobpress.png" alt="JobPress" width="120" height="90"></a>
4333
</div>
4434

45-
## Features
46-
47-
- Harness the power of [Laravel](https://laravel.com) and its available packages thanks to [Acorn](https://github.com/roots/acorn).
48-
- Clean, efficient theme templating utilizing [Laravel Blade](https://laravel.com/docs/master/blade).
49-
- Lightning fast frontend development workflow powered by [Bud](https://bud.js.org/).
50-
- Out of the box support for [Tailwind CSS](https://tailwindcss.com/).
51-
52-
## Requirements
53-
54-
Make sure all dependencies have been installed before moving on:
55-
56-
- [Acorn](https://roots.io/acorn/docs/installation/) v3
57-
- [WordPress](https://wordpress.org/) >= 5.9
58-
- [PHP](https://secure.php.net/manual/en/install.php) >= 8.0 (with [`php-mbstring`](https://secure.php.net/manual/en/book.mbstring.php) enabled)
59-
- [Composer](https://getcomposer.org/download/)
60-
- [Node.js](http://nodejs.org/) >= 16
61-
- [Yarn](https://yarnpkg.com/en/docs/install)
62-
63-
## Theme installation
64-
65-
Install Sage using Composer from your WordPress themes directory (replace `your-theme-name` below with the name of your theme):
66-
67-
```sh
68-
# @ app/themes/ or wp-content/themes/
69-
$ composer create-project roots/sage your-theme-name
70-
```
71-
72-
To install the latest development version of Sage, add `dev-main` to the end of the command:
73-
74-
```sh
75-
$ composer create-project roots/sage your-theme-name dev-main
76-
```
77-
78-
Make sure that you have [Acorn installed](https://docs.roots.io/acorn/2.x/installation/).
79-
80-
## Theme structure
81-
82-
```sh
83-
themes/your-theme-name/ # → Root of your Sage based theme
84-
├── app/ # → Theme PHP
85-
│ ├── Providers/ # → Service providers
86-
│ ├── View/ # → View models
87-
│ ├── filters.php # → Theme filters
88-
│ └── setup.php # → Theme setup
89-
├── composer.json # → Autoloading for `app/` files
90-
├── public/ # → Built theme assets (never edit)
91-
├── functions.php # → Theme bootloader
92-
├── index.php # → Theme template wrapper
93-
├── node_modules/ # → Node.js packages (never edit)
94-
├── package.json # → Node.js dependencies and scripts
95-
├── resources/ # → Theme assets and templates
96-
│ ├── fonts/ # → Theme fonts
97-
│ ├── images/ # → Theme images
98-
│ ├── scripts/ # → Theme javascript
99-
│ ├── styles/ # → Theme stylesheets
100-
│ └── views/ # → Theme templates
101-
│ ├── components/ # → Component templates
102-
│ ├── forms/ # → Form templates
103-
│ ├── layouts/ # → Base templates
104-
│ ├── partials/ # → Partial templates
105-
└── sections/ # → Section templates
106-
├── screenshot.png # → Theme screenshot for WP admin
107-
├── style.css # → Theme meta information
108-
├── vendor/ # → Composer packages (never edit)
109-
└── bud.config.js # → Bud configuration
110-
```
111-
112-
## Theme setup
113-
114-
Edit `app/setup.php` to enable or disable theme features, setup navigation menus, post thumbnail sizes, and sidebars.
115-
116-
## Theme development
35+
## Overview
11736

118-
- Run `yarn` from the theme directory to install dependencies
119-
- Update `bud.config.js` with your local dev URL
37+
Sage is a WordPress starter theme with block editor support.
12038

121-
### Build commands
39+
- Harness the power of [Laravel](https://laravel.com) and its available packages thanks to [Acorn](https://github.com/roots/acorn)
40+
- Clean, efficient theme templating utilizing [Laravel Blade](https://laravel.com/docs/master/blade)
41+
- Modern frontend development workflow powered by [Bud](https://bud.js.org/)
42+
- Out of the box support for [Tailwind CSS](https://tailwindcss.com/)
12243

123-
- `yarn dev` — Compile assets when file changes are made, start Browsersync session
124-
- `yarn build` — Compile assets for production
44+
## Getting Started
12545

126-
## Community
46+
See the [Sage installation documentation](https://roots.io/sage/docs/installation/).
12747

128-
Keep track of development and community news.
48+
## Stay Connected
12949

13050
- Join us on Discord by [sponsoring us on GitHub](https://github.com/sponsors/roots)
131-
- Participate on the [Roots Discourse](https://discourse.roots.io/)
51+
- Participate on [Roots Discourse](https://discourse.roots.io/)
13252
- Follow [@rootswp on Twitter](https://twitter.com/rootswp)
133-
- Read and subscribe to the [Roots Blog](https://roots.io/blog/)
134-
- Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)
53+
- Read the [Roots Blog](https://roots.io/blog/)
54+
- Subscribe to the [Roots Newsletter](https://roots.io/newsletter/)

0 commit comments

Comments
 (0)