PHPackages                             royalcms/readme - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. royalcms/readme

ActiveLibrary[Utility & Helpers](/categories/utility)

royalcms/readme
===============

Royalcms Packages's Readme File(Docs) Viewer.

v5.0.0(6y ago)07MITHTMLPHP >=5.5.9

Since Sep 4Pushed 6y ago1 watchersCompare

[ Source](https://github.com/royalcms/royalcms-readme)[ Packagist](https://packagist.org/packages/royalcms/readme)[ Docs](http://royalcms.cn)[ RSS](/packages/royalcms-readme/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (2)Versions (2)Used By (0)

Royalcms Packages's Readme File(Docs) Viewer
--------------------------------------------

[](#royalcms-packagess-readme-filedocs-viewer)

This package generates a html page that you can see all of your packages's readme file, So you no longer need to go to each package's homepage to find documents。

### Install

[](#install)

Require this package with composer using the following command:

```
composer require royalcms/readme
```

After updating composer, add the service provider to the `providers` array in `config/provider.php`

```
Royalcms\Component\Readme\ReadmeServiceProvider::class,
```

To install this package on only development systems, add the `--dev` flag to your composer command:

```
composer require --dev royalcms/readme
```

In Royalcms, instead of adding the service provider in the `config/system.php` file, you can add the following code to your `app/Providers/AppServiceProvider.php` file, within the `register()` method:

```
public function register()
{
    if ($this->royalcms->environment() == 'local') {
        $this->royalcms->register('Royalcms\Component\Readme\ReadmeServiceProvider');
    }
    // ...
}
```

This will allow your application to load the Royalcms Packages's Readme File(Docs) Viewer on non-production enviroments.

### Usage

[](#usage)

You can now view all the docs of your packages in your browser by follow url.

```
http://yoursite.app/readme
```

### Custom Route

[](#custom-route)

If you need to custom route, you need to publish config file first

```
php artisan vendor:publish --tag=readme
```

Then you can change route in '/config/readme.php'

```
'route' => [
        'prefix' => '/readme/{packageName?}',
        'action' => 'Royalcms\Component\Readme\Controllers\ReadmeController@index',
        'name' => 'readme.index',
],
```

### License

[](#license)

The Royalcms Packages's Readme File(Docs) Viewer is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2444d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1106638?v=4)[Hao.Dongfang](/maintainers/royalwang)[@royalwang](https://github.com/royalwang)

---

Top Contributors

[![royalwang](https://avatars.githubusercontent.com/u/1106638?v=4)](https://github.com/royalwang "royalwang (1 commits)")

### Embed Badge

![Health badge](/badges/royalcms-readme/health.svg)

```
[![Health](https://phpackages.com/badges/royalcms-readme/health.svg)](https://phpackages.com/packages/royalcms-readme)
```

###  Alternatives

[spatie/laravel-data

Create unified resources and data transfer objects

1.7k28.9M627](/packages/spatie-laravel-data)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)