summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSimon Wisselink <s.wisselink@iwink.nl>2021-10-13 22:49:43 +0200
committerSimon Wisselink <s.wisselink@iwink.nl>2021-10-13 22:49:43 +0200
commitffb2fd923b6c939e65d9504e9a537490d37bb067 (patch)
tree3e6ebe6272ad9738a4866ca6b4caac16817cb4bb /README.md
parent64a6333d5d35d9bddd537dfe81cce768c3eafa50 (diff)
downloadsmarty-ffb2fd923b6c939e65d9504e9a537490d37bb067.tar.gz
smarty-ffb2fd923b6c939e65d9504e9a537490d37bb067.tar.bz2
smarty-ffb2fd923b6c939e65d9504e9a537490d37bb067.zip
Update README.md. Fix references to Smarty3. Get rid of old changelog-like files.
Diffstat (limited to 'README.md')
-rw-r--r--README.md81
1 files changed, 17 insertions, 64 deletions
diff --git a/README.md b/README.md
index 112b8f63..de091b10 100644
--- a/README.md
+++ b/README.md
@@ -1,75 +1,28 @@
-# Smarty 3 template engine
-[smarty.net](https://www.smarty.net/)
+# Smarty template engine
+Smarty is a template engine for PHP, facilitating the separation of presentation (HTML/CSS) from application logic.
![CI](https://github.com/smarty-php/smarty/workflows/CI/badge.svg)
## Documentation
-
-For documentation see
-[www.smarty.net/docs/en/](https://www.smarty.net/docs/en/)
+Read the [documentation](https://www.smarty.net/docs/en/) to find out how to use it.
## Requirements
Smarty can be run with PHP 7.1 to PHP 8.0.
-## Distribution repository
-
-> Smarty 3.1.28 introduces run time template inheritance
-
-> Read the NEW_FEATURES and INHERITANCE_RELEASE_NOTES file for recent extensions to Smarty 3.1 functionality
-
-Smarty versions 3.1.11 or later are now on GitHub and can be installed with Composer.
-
-
-The "smarty/smarty" package will start at libs/.... subfolder.
-
-To get the latest stable version of Smarty 3.1 use:
-
-```json
-"require": {
- "smarty/smarty": "~3.1"
-}
-```
-
-in your composer.json file.
-
-To get the trunk version use:
-
-```json
-"require": {
- "smarty/smarty": "~3.1@dev"
-}
-```
-
-For a specific version use something like:
-
-```json
-"require": {
- "smarty/smarty": "3.1.19"
-}
-```
-
-PHPUnit test can be installed by corresponding composer entries like:
-
-```json
-"require": {
- "smarty/smarty-phpunit": "3.1.19"
-}
-```
-
-Similar applies for the lexer/parser generator.
-
-```json
-"require": {
- "smarty/smarty-lexer": "3.1.19"
-}
-```
+## Installation
+Smarty versions 3.1.11 or later can be installed with [Composer](https://getcomposer.org/).
-Or you could use:
+To get the latest stable version of Smarty use:
+```bash
+composer require smarty/smarty
+````
-```json
-"require": {
- "smarty/smarty-dev": "3.1.19"
-}
-```
+To get the latest, unreleased version, use:
+```bash
+composer require smarty/smarty:dev-master
+````
-Which is a wrapper to install all 3 packages.
+To get the previous stable version of Smarty, Smarty 3, use:
+```bash
+composer require smarty/smarty:^3
+````