Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Nicholas K. Dionysopoulos <nicholas@akeeba.com>
  • Loading branch information
nikosdion committed Oct 26, 2023
1 parent 6595925 commit c309f5c
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Self-hosted site monitoring and management


[![Documentation](https://img.shields.io/badge/documentation-wiki-ffffff?labelColor=514f50&color=40b5b8)](https://github.com/akeeba/panopticon/wiki) &nbsp; [![Downloads](https://img.shields.io/github/downloads/akeeba/panopticon/total?labelColor=514f50&color=40b5b8)](https://github.com/akeeba/panopticon/releases)
[![Documentation](https://img.shields.io/badge/documentation-wiki-ffffff?labelColor=514f50&color=40b5b8)](https://github.com/akeeba/panopticon/wiki) &nbsp; [![Downloads](https://img.shields.io/github/downloads/akeeba/panopticon/total?labelColor=514f50&color=40b5b8)](https://github.com/akeeba/panopticon/releases) &nbsp; [![Translations on Weblate](https://img.shields.io/badge/Weblate-Translations-40b5b8?labelColor=514f50)](https://hosted.weblate.org/projects/akeeba-panopticon/)

## What is it?

Expand All @@ -23,4 +23,26 @@ Clone the repository.

Go into the folder where you cloned the repository and run `composer install`. This is important! This step installs PHP dependencies, runs `npm install`, compiles SCSS files into CSS, minifies JavaScript files, puts all external static resources in the folder Panopticon expects them to be, and generates a few necessary files (such as `version.php`).

You can now either use the [web installer](https://github.com/akeeba/panopticon/wiki/Install-Panopticon) or the [CLI installation](https://github.com/akeeba/panopticon/wiki/CLI-setup) method.
You can now either use the [web installer](https://github.com/akeeba/panopticon/wiki/Install-Panopticon) or the [CLI installation](https://github.com/akeeba/panopticon/wiki/CLI-setup) method.

## Translations

🚧 **WORK IN PROGRESS** 🚧 – The translation environment is currently being provisioned.

Akeeba Panopticon uses Weblate (https://weblate.org) for managing its translations. Anyone can become a translator by joining the [public translation project](https://hosted.weblate.org/projects/akeeba-panopticon/) there.

Translations are _community–led_ and licensed under the GNU Affero General Public License version 3, or (at your option) any later version.

Community–led translations means that we have no responsibility for the contents of the offered translations, including the terminology used, spelling and grammar errors, and accuracy. The only officially supported language of Akeeba Panopticon is English (Great Britain).

## License Notice

Akeeba Panopticon – Self-hosted site monitoring and management

Copyright (C) 2023 Akeeba Ltd

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received [a copy of the GNU Affero General Public License](LICENSE.txt) along with this program. If not, see <https://www.gnu.org/licenses/>.

0 comments on commit c309f5c

Please sign in to comment.