Applied StyleCI changes, updated readme badges & roadmap

diff --git a/app/Auth/Queries/AllUsersPaginatedAndSorted.php b/app/Auth/Queries/AllUsersPaginatedAndSorted.php
index 664db1925a1a6a977d5656037544bd593388af60..7b849eaf4c1af9f84036cf8eeb1aa24f89716836 100644 (file)
--- a/app/Auth/Queries/AllUsersPaginatedAndSorted.php
+++ b/app/Auth/Queries/AllUsersPaginatedAndSorted.php
@@ -2,7 +2,6 @@
 
 namespace BookStack\Auth\Queries;
 
-
 use BookStack\Auth\User;
 use Illuminate\Pagination\LengthAwarePaginator;
 
@@ -14,7 +13,6 @@ use Illuminate\Pagination\LengthAwarePaginator;
  */
 class AllUsersPaginatedAndSorted
 {
-
     /**
      * @param array{sort: string, order: string, search: string} $sortData
      */
@@ -38,5 +36,4 @@ class AllUsersPaginatedAndSorted
 
         return $query->paginate($count);
     }
-
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Queries/UserContentCounts.php b/app/Auth/Queries/UserContentCounts.php
index b8d99be148be82d8d129bb011558d6f63f35c013..397719383f73461ed15516ff6ad4128059a7a666 100644 (file)
--- a/app/Auth/Queries/UserContentCounts.php
+++ b/app/Auth/Queries/UserContentCounts.php
@@ -27,4 +27,4 @@ class UserContentCounts
             'shelves'  => Bookshelf::visible()->where($createdBy)->count(),
         ];
     }
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Queries/UserRecentlyCreatedContent.php b/app/Auth/Queries/UserRecentlyCreatedContent.php
index 31dd9de68eb6f1e1aca5f223d46c0054a2e850af..5060227c07121106af647d0bc2c285e4caf1ccd4 100644 (file)
--- a/app/Auth/Queries/UserRecentlyCreatedContent.php
+++ b/app/Auth/Queries/UserRecentlyCreatedContent.php
@@ -34,4 +34,4 @@ class UserRecentlyCreatedContent
             'shelves'  => $query(Bookshelf::visible()),
         ];
     }
-}
\ No newline at end of file
+}

diff --git a/app/Entities/Tools/ExportFormatter.php b/app/Entities/Tools/ExportFormatter.php
index 5617db6925f51a65168efe7ec072fd15fc517e75..7edd1b50f99d27b74448cee27dee0b46b7527bb4 100644 (file)
--- a/app/Entities/Tools/ExportFormatter.php
+++ b/app/Entities/Tools/ExportFormatter.php
@@ -153,7 +153,7 @@ class ExportFormatter
     }
 
     /**
-     * Within the given HTML content, Open any detail blocks
+     * Within the given HTML content, Open any detail blocks.
      */
     protected function openDetailElements(string $html): string
     {

diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php
index a22b0394ae37716631d9ffc6d90a4c03b64b0cbd..2c92036871e6cf07c7c1eef5b15bd573cb385352 100644 (file)
--- a/app/Http/Controllers/UserController.php
+++ b/app/Http/Controllers/UserController.php
@@ -48,8 +48,8 @@ class UserController extends Controller
         $users->appends($listDetails);
 
         return view('users.index', [
-            'users' => $users,
-            'listDetails' => $listDetails
+            'users'       => $users,
+            'listDetails' => $listDetails,
         ]);
     }
 

diff --git a/readme.md b/readme.md
index 7829026ade9552bbd169a4664b39ce39bd7e4ca8..6bc34256aa5fe27c3bef5665d084a1b1ba03c3dc 100644 (file)
--- 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** - *(Started)*
     - *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.*