Skip to content

Commit 3946f70

Browse files
committed
Updated the readme + default template
1 parent 7454180 commit 3946f70

File tree

2 files changed

+40
-36
lines changed

2 files changed

+40
-36
lines changed

README.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,41 @@
22

33
## About Craft CMS
44

5-
Craft is a content-first CMS that aims to make life enjoyable for developers and content managers alike. It is optimized for bespoke web and application development, offering developers a clean slate to build out exactly what they want, rather than wrestling with a theme.
5+
Craft is a flexible and scalable CMS for creating bespoke digital experiences on the web and beyond.
66

7-
Learn more about Craft at [craftcms.com](https://craftcms.com).
7+
It features:
88

9-
## How to Install Craft 3
9+
- An intuitive Control Panel for administration tasks and content creation.
10+
- A clean-slate approach to content modeling and [front-end development](https://docs.craftcms.com/v3/dev/).
11+
- A built-in Plugin Store with hundreds of free and commercial [plugins](https://plugins.craftcms.com/).
12+
- A robust framework for [module and plugin development](https://docs.craftcms.com/v3/extend/).
1013

11-
See the Craft 3 documentation for [installation](https://docs.craftcms.com/v3/installation.html) and [updating](https://docs.craftcms.com/v3/updating.html) instructions.
14+
Learn more about it at [craftcms.com](https://craftcms.com).
15+
16+
## Tech Specs
17+
18+
Craft is written in PHP (7+), and built on the [Yii 2 framework](https://www.yiiframework.com/). It can connect to MySQL (5.5+) and PostgreSQL (9.5+) for content storage.
19+
20+
## Installation
21+
22+
See the following documentation pages for help installing Craft 3:
23+
24+
- [Server Requirements](https://docs.craftcms.com/v3/requirements.html)
25+
- [Installation Instructions](https://docs.craftcms.com/v3/installation.html)
26+
- [Upgrading from Craft 2](https://docs.craftcms.com/v3/upgrade.html)
1227

1328
## Resources
1429

1530
#### Official Resources
16-
- [Craft 3 Documentation](https://docs.craftcms.com/v3/)
17-
- [Craft 3 Class Reference](https://docs.craftcms.com/api/v3/)
18-
- [Craft 3 Plugins](https://plugins.craftcms.com)
19-
- [Demo site](https://demo.craftcms.com/)
20-
- [Craft Slack](https://craftcms.com/community#slack)
21-
- [Craft CMS Stack Exchange](http://craftcms.stackexchange.com/)
31+
- [Documentation](https://docs.craftcms.com/v3/) – Everything from usage instructions to plugin guides.
32+
- [Class Reference](https://docs.craftcms.com/api/v3/) – Full API and class reference for plugin and module developers.
33+
- [Demo site](https://demo.craftcms.com/) – Quickly launch a personalized demo of a Craft site.
34+
- [Craft Slack](https://craftcms.com/community#slack) – Join one of the most friendly and helpful Slack groups around.
35+
- [Craft Commerce](https://craftcommerce.com/) – First-party e-commerce platform for Craft.
2236

2337
#### Community Resources
24-
- [Mijingo](https://mijingo.com/craft) – Video courses and other learning resources
25-
- [Envato Tuts+](https://webdesign.tutsplus.com/categories/craft-cms/courses) – Video courses
26-
- [Straight Up Craft](http://straightupcraft.com/) – Articles, tutorials, and more
27-
- [pluginfactory.io](https://pluginfactory.io/) – Craft plugin scaffold generator
38+
- [CraftQuest](https://craftquest.io/) – Unlimited access to Craft training (and more) from Mijingo.
39+
- [Envato Tuts+](https://webdesign.tutsplus.com/categories/craft-cms/courses) – Video courses.
40+
- [nystudio107 Blog](http://straightupcraft.com/) – Articles about Craft and modern web development.
41+
- [pluginfactory.io](https://pluginfactory.io/) – Craft plugin scaffold generator.
42+
- [Craft CMS Stack Exchange](http://craftcms.stackexchange.com/) – Community-run Q&A for Craft developers.

templates/index.html

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -193,32 +193,21 @@ <h1>Welcome</h1>
193193
</div>
194194
<div id="aside">
195195
<div class="content">
196-
{% set officialResources = [
197-
{ label: "Craft 3 Documentation", url: 'http://docs.craftcms.com/v3/' },
198-
{ label: "Craft 3 Class Reference", url: 'https://docs.craftcms.com/api/v3/' },
199-
{ label: "Craft 3 Plugins", url: 'https://plugins.craftcms.com' },
200-
{ label: "Demo site", url: 'https://demo.craftcms.com/' },
201-
{ label: "Craft Slack", url: 'https://craftcms.com/community#slack' },
202-
{ label: "Craft CMS Stack Exchange", url: 'http://craftcms.stackexchange.com/' },
203-
] %}
204196
<h2>Official Resources</h2>
205-
<ul>
206-
{% for resource in officialResources %}
207-
<li><a href="{{ resource.url }}" title="{{ resource.label }}" target="_blank">{{ resource.label }}</a></li>
208-
{% endfor %}
209-
</ul>
197+
<ul>
198+
<li><a href="http://docs.craftcms.com/v3/" target="_blank">Craft 3 Documentation</a></li>
199+
<li><a href="https://docs.craftcms.com/api/v3/" target="_blank">Craft 3 Class Reference</a></li>
200+
<li><a href="https://demo.craftcms.com/" target="_blank">Demo site</a></li>
201+
<li><a href="https://craftcms.com/community#slack" target="_blank">Craft Slack</a></li>
202+
<li><a href="https://craftcommerce.com/" target="_blank">Craft Commerce</a> <small>– First-party e-commerce platform for Craft.</small></li>
203+
</ul>
210204

211-
{% set communityResources = [
212-
{ label: "Mijingo", description: "Video courses and other learning resources", url: 'https://mijingo.com/craft' },
213-
{ label: "Envato Tuts+", description: "Video courses", url: 'https://webdesign.tutsplus.com/categories/craft-cms/courses' },
214-
{ label: "Straight Up Craft", description: "Articles, tutorials, and more", url: 'http://straightupcraft.com/' },
215-
{ label: "pluginfactory.io", description: "Craft plugin and module scaffold generator", url: 'https://pluginfactory.io/' },
216-
] %}
217205
<h2>Community Resources</h2>
218206
<ul>
219-
{% for resource in communityResources %}
220-
<li><a href="{{ resource.url }}" title="{{ resource.label }} – {{ resource.description }}" target="_blank">{{ resource.label }}</a><small> – {{ resource.description }}</small></li>
221-
{% endfor %}
207+
<li><a href="https://craftquest.io/" target="_blank">CraftQuest</a> <small>– Unlimited access to Craft training (and more) from Mijingo.</small></li>
208+
<li><a href="https://webdesign.tutsplus.com/categories/craft-cms/courses" target="_blank">Envato Tuts+</a> <small>– Video courses.</small></li>
209+
<li><a href="http://straightupcraft.com/" target="_blank">nystudio107 Blog</a> <small>– Articles about Craft and modern web development.</small></li>
210+
<li><a href="http://craftcms.stackexchange.com/" target="_blank">Craft CMS Stack Exchange</a> <small>– Community-run Q&A for Craft developers.</small></li>
222211
</ul>
223212
</div>
224213
</div>

0 commit comments

Comments
 (0)