Skip to content

Commit

Permalink
#7 improved readme and created changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Vec7or committed Jul 25, 2020
1 parent 1d0c9bc commit 00a438e
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 9 deletions.
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [1.0.0] - 2020-07-24

### Added

- Basic glossary functionality
- Admin Backend
- Adjustable frontend
- Support for multi-language websites
- Language support for English, French, German and Italian
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,19 @@ Glossary block for the Gutenberg editor.

### Overview

This plugin provides a glossary-block for the WordPress-Gutenberg-Editor. It also includes a backend to add, update and remove entries from within the glossary.
This plugin provides a multilanguage glossary-block for the WordPress-Gutenberg-Editor. It also includes a backend to add, update and remove entries from within the glossary.

### Install

To install the plugin simply download it from the [WordPress repository](https://wordpress.org/plugins/search/glossary-by-arteeo/). After activation within your WordPress instance the plugin is ready to go.

### Features

The plugin currently supports the following languages in the frontend as well as the backend:

1. English
2. French
3. German
4. Italian

- The plugin actively supports multi-language sites and offers the following languages in both the frontend and the backend:
- English
- French
- German
- Italian
- The backend has filtering options to filter by letter and language.
- The colors of the frontend are completely adjustable.
- The frontend adjusts itself to fit the container size (responsive / mobile friendly).
Expand All @@ -42,6 +40,10 @@ The plugin currently supports the following languages in the frontend as well as

## Developers

### Contributing

We really appreciate the time and effort many developers invest into open source. We welcome anyone interested in contributing to this repository. However, when contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

### Dependencies

The following software has to be installed in order for you to be able to adjust and build this plugin (newer versions should also work):
Expand Down Expand Up @@ -101,4 +103,4 @@ The following software has to be installed in order for you to be able to adjust

#### More

WordPress-Scripts is a dependency, therefore all scripts described [here](https://developer.wordpress.org/block-editor/packages/packages-scripts/) are theoretically available.
WordPress-Scripts is a dependency, therefore all scripts described [here](https://developer.wordpress.org/block-editor/packages/packages-scripts/) are theoretically available.

0 comments on commit 00a438e

Please sign in to comment.