X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/e17cdab4208a735835233fd50beceda51e28f2fa..refs/pull/3433/head:/readme.md diff --git a/readme.md b/readme.md index a1a4501ef..25c840a62 100644 --- a/readme.md +++ b/readme.md @@ -3,10 +3,14 @@ [![GitHub release](https://img.shields.io/github/release/BookStackApp/BookStack.svg)](https://github.com/BookStackApp/BookStack/releases/latest) [![license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/BookStackApp/BookStack/blob/development/LICENSE) [![Crowdin](https://badges.crowdin.net/bookstack/localized.svg)](https://crowdin.com/project/bookstack) -[![Discord](https://img.shields.io/static/v1?label=chat&message=discord&color=738adb&logo=discord)](https://discord.gg/ztkBqR2) -[![Repo Stats](https://img.shields.io/static/v1?label=GitHub+project&message=stats&color=f27e3f)](https://gh-stats.bookstackapp.com/) [![Build Status](https://github.com/BookStackApp/BookStack/workflows/phpunit/badge.svg)](https://github.com/BookStackApp/BookStack/actions) [![StyleCI](https://github.styleci.io/repos/41589337/shield?style=flat)](https://github.styleci.io/repos/41589337) +[![Maintainability](https://api.codeclimate.com/v1/badges/5551731994dd22fa1f4f/maintainability)](https://codeclimate.com/github/BookStackApp/BookStack/maintainability) + +[![Repo Stats](https://img.shields.io/static/v1?label=GitHub+project&message=stats&color=f27e3f)](https://gh-stats.bookstackapp.com/) +[![Discord](https://img.shields.io/static/v1?label=Discord&message=chat&color=738adb&logo=discord)](https://discord.gg/ztkBqR2) +[![Twitter](https://img.shields.io/static/v1?label=Twitter&message=@bookstack_app&color=1d9bf0&logo=twitter)](https://twitter.com/bookstack_app) +[![YouTube](https://img.shields.io/static/v1?label=YouTube&message=bookstackapp&color=ff0000&logo=youtube)](https://www.youtube.com/bookstackapp) A platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://www.bookstackapp.com/. @@ -57,9 +61,9 @@ Note: Listed services are not tested, vetted nor supported by the official BookS Below is a high-level road map view for BookStack to provide a sense of direction of where the project is going. This can change at any point and does not reflect many features and improvements that will also be included as part of the journey along this road map. For more granular detail of what will be included in upcoming releases you can review the project milestones as defined in the "Release Process" section below. -- **Platform REST API** *(Base Implemented, In review and roll-out)* +- **Platform REST API** - *(Most actions implemented, maturing)* - *A REST API covering, at minimum, control of core content models (Books, Chapters, Pages) for automation and platform extension.* -- **Editor Alignment & Review** +- **Editor Alignment & Review** - *(In Progress)* - *Review the page editors with goal of achieving increased interoperability & feature parity while also considering collaborative editing potential.* - **Permission System Review** - *Improvement in how permissions are applied and a review of the efficiency of the permission & roles system.* @@ -200,7 +204,10 @@ The website which contains the project docs & Blog can be found in the [BookStac ## ⚖️ License -The BookStack source is provided under the MIT License. The libraries used by, and included with, BookStack are provided under their own licenses. +The BookStack source is provided under the MIT License. + +The libraries used by, and included with, BookStack are provided under their own licenses and copyright. +The licenses for many of our core dependencies can be found in the attribution list below but this is not an exhaustive list of all projects used within BookStack. ## 👪 Attribution @@ -208,26 +215,28 @@ The great people that have worked to build and improve BookStack can [be seen he The wonderful people that have provided translations, either through GitHub or via Crowdin [can be seen here](https://github.com/BookStackApp/BookStack/blob/development/.github/translators.txt). -These are the great open-source projects used to help build BookStack: - -* [Laravel](http://laravel.com/) -* [TinyMCE](https://www.tinymce.com/) -* [CodeMirror](https://codemirror.net) -* [Sortable](https://github.com/SortableJS/Sortable) -* [Google Material Icons](https://material.io/icons/) -* [Dropzone.js](http://www.dropzonejs.com/) -* [clipboard.js](https://clipboardjs.com/) -* [markdown-it](https://github.com/markdown-it/markdown-it) and [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists) -* [BarryVD/Dompdf](https://github.com/barryvdh/laravel-dompdf) -* [BarryVD/Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy) -* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html) -* [diagrams.net](https://github.com/jgraph/drawio) -* [OneLogin's SAML PHP Toolkit](https://github.com/onelogin/php-saml) -* [League/CommonMark](https://commonmark.thephpleague.com/) -* [League/Flysystem](https://flysystem.thephpleague.com) -* [StyleCI](https://styleci.io/) -* [pragmarx/google2fa](https://github.com/antonioribeiro/google2fa) -* [Bacon/BaconQrCode](https://github.com/Bacon/BaconQrCode) -* [phpseclib](https://github.com/phpseclib/phpseclib) -* [Clockwork](https://github.com/itsgoingd/clockwork) -* [PHPStan](https://phpstan.org/) & [Larastan](https://github.com/nunomaduro/larastan) \ No newline at end of file +Below are the great open-source projects used to help build BookStack. +Note: This is not an exhaustive list of all libraries and projects that would be used in an active BookStack instance. + +* [Laravel](http://laravel.com/) - _[MIT](https://github.com/laravel/framework/blob/v8.82.0/LICENSE.md)_ +* [TinyMCE](https://www.tinymce.com/) - _[LGPL v2.1](https://github.com/tinymce/tinymce/blob/develop/LICENSE.TXT)_ +* [CodeMirror](https://codemirror.net) - _[MIT](https://github.com/codemirror/CodeMirror/blob/master/LICENSE)_ +* [Sortable](https://github.com/SortableJS/Sortable) - _[MIT](https://github.com/SortableJS/Sortable/blob/master/LICENSE)_ +* [Google Material Icons](https://github.com/google/material-design-icons) - _[Apache-2.0](https://github.com/google/material-design-icons/blob/master/LICENSE)_ +* [Dropzone.js](http://www.dropzonejs.com/) - _[MIT](https://github.com/dropzone/dropzone/blob/main/LICENSE)_ +* [clipboard.js](https://clipboardjs.com/) - _[MIT](https://github.com/zenorocha/clipboard.js/blob/master/LICENSE)_ +* [markdown-it](https://github.com/markdown-it/markdown-it) and [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists) - _[MIT](https://github.com/markdown-it/markdown-it/blob/master/LICENSE) and [ISC](https://github.com/revin/markdown-it-task-lists/blob/master/LICENSE)_ +* [Dompdf](https://github.com/dompdf/dompdf) - _[LGPL v2.1](https://github.com/dompdf/dompdf/blob/master/LICENSE.LGPL)_ +* [BarryVD/Dompdf](https://github.com/barryvdh/laravel-dompdf) - _[MIT](https://github.com/barryvdh/laravel-dompdf/blob/master/LICENSE)_ +* [BarryVD/Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy) - _[MIT](https://github.com/barryvdh/laravel-snappy/blob/master/LICENSE)_ +* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html) - _[LGPL v3.0](https://github.com/wkhtmltopdf/wkhtmltopdf/blob/master/LICENSE)_ +* [diagrams.net](https://github.com/jgraph/drawio) - _[Embedded Version Terms](https://www.diagrams.net/trust/) / [Source Project - Apache-2.0](https://github.com/jgraph/drawio/blob/dev/LICENSE)_ +* [OneLogin's SAML PHP Toolkit](https://github.com/onelogin/php-saml) - _[MIT](https://github.com/onelogin/php-saml/blob/master/LICENSE)_ +* [League/CommonMark](https://commonmark.thephpleague.com/) - _[BSD-3-Clause](https://github.com/thephpleague/commonmark/blob/2.2/LICENSE)_ +* [League/Flysystem](https://flysystem.thephpleague.com) - _[MIT](https://github.com/thephpleague/flysystem/blob/3.x/LICENSE)_ +* [StyleCI](https://styleci.io/) - _Hosted Service_ +* [pragmarx/google2fa](https://github.com/antonioribeiro/google2fa) - _[MIT](https://github.com/antonioribeiro/google2fa/blob/8.x/LICENSE.md)_ +* [Bacon/BaconQrCode](https://github.com/Bacon/BaconQrCode) - _[BSD-2-Clause](https://github.com/Bacon/BaconQrCode/blob/master/LICENSE)_ +* [phpseclib](https://github.com/phpseclib/phpseclib) - _[MIT](https://github.com/phpseclib/phpseclib/blob/master/LICENSE)_ +* [Clockwork](https://github.com/itsgoingd/clockwork) - _[MIT](https://github.com/itsgoingd/clockwork/blob/master/LICENSE)_ +* [PHPStan](https://phpstan.org/) & [Larastan](https://github.com/nunomaduro/larastan) - _[MIT](https://github.com/phpstan/phpstan/blob/master/LICENSE) and [MIT](https://github.com/nunomaduro/larastan/blob/master/LICENSE.md)_ \ No newline at end of file