Skip to content

Commit

Permalink
docs: update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
kalvn committed Dec 24, 2024
1 parent 5c03319 commit 17be71f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,23 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [v0.14.0](https://github.com/kalvn/Shaarli-Material/releases/tag/v0.14.0) - unreleased
### Added
- Support for Shaarli v0.14.0.

### Changed
- Update links on the Tools page.
- Move from ESLint standard to neostandard for linting JS.

### Removed
- Babel for transpilation.
- Core-JS for old-browser support.


## [v0.12.2](https://github.com/kalvn/Shaarli-Material/releases/tag/v0.12.2) - 2024-12-23
### Added
- Support for Shaarli v0.12.2.
- Support for Shaarli v0.12.2 and v0.13.0.
- Support for new core plugin ReadItLater.

### Removed
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Shaarli Material is a theme for [Shaarli](https://github.com/shaarli/Shaarli), t
## Compatibility
Shaarli Material follows the exact same versions numbers than Shaarli. It means that if you install Shaarli vX.Y.Z, you must use Shaarli Material vX.Y.Z.

Shaarli Material was tested and validated with **Shaarli 0.12.1**.
Shaarli Material was tested and validated with **Shaarli 0.14.0**.


## Download
Expand Down Expand Up @@ -64,11 +64,13 @@ Then, anything you add in this file will be included at the end of the `<head>`

This file is NOT commited on the repository, which allows you to update the theme without overriding this file.


## Plugins
As from Shaarli v0.6.0, you can install plugins to enrich your experience.
Most of them should work properly, although it's up to the plugin developer to ensure the code is as minimal as possible to integrates well in custom themes.
I tested all plugins available with Shaarli 0.6.0 and they all work well even though the display is a bit weird for some of them. I will keep monitoring the behavior of popular plugins in the future.


## Libraries used
This theme uses a few JavaScript libraries.

Expand Down Expand Up @@ -102,7 +104,6 @@ $ npm install
$ npm run build
```


------------------------------------------------------------------------------

You can download Shaarli via the Github project page: https://github.com/shaarli/Shaarli
Expand Down

0 comments on commit 17be71f

Please sign in to comment.