|
@@ -1,16 +1,15 @@
|
|
|
<h1 align="center">Scribe</h1>
|
|
|
|
|
|
+[](https://packagist.org/packages/knuckleswtf/scribe) [](https://packagist.org/packages/knuckleswtf/scribe) [](https://travis-ci.com/knuckleswtf/scribe)
|
|
|
+
|
|
|
<p align="center">
|
|
|
<img src="logo-scribe.png"><br>
|
|
|
</p>
|
|
|
|
|
|
-> Still on v2? Here's the [v3 migration guide](https://scribe.knuckles.wtf/laravel/migrating-v3).
|
|
|
|
|
|
-Scribe helps you generate API documentation for humans from your Laravel/Lumen/[Dingo](https://github.com/dingo/api) codebase. See a live example at [demo.scribe.knuckles.wtf](https://demo.scribe.knuckles.wtf). There's a [Node.js version](https://github.com/knuckleswtf/scribe-js), too!
|
|
|
-
|
|
|
-[](https://packagist.org/packages/knuckleswtf/scribe) [](https://packagist.org/packages/knuckleswtf/scribe) [](https://travis-ci.com/knuckleswtf/scribe)
|
|
|
+> [v3 is out now](https://scribe.knuckles.wtf/blog/2021/06/08/laravel-v3)!
|
|
|
|
|
|
-> 👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable and testable API docs, there's some more things you need to know. So I made [a course](https://apidocsfordevs.com?utm_source=scribe-laravel&utm_medium=referral&utm_campaign=none) for you.🤗
|
|
|
+Scribe helps you generate API documentation for humans from your Laravel/Lumen/[Dingo](https://github.com/dingo/api) codebase. See a live example at [demo.scribe.knuckles.wtf](https://demo.scribe.knuckles.wtf). There's a [Node.js version](https://github.com/knuckleswtf/scribe-js), too!
|
|
|
|
|
|
## Features
|
|
|
- Pretty single-page HTML doc, with human-friendly text, code samples, and included in-browser API tester ("Try It Out")
|
|
@@ -22,6 +21,8 @@ Scribe helps you generate API documentation for humans from your Laravel/Lumen/[
|
|
|
- Easily extensible with custom strategies
|
|
|
- Statically define extra endpoints that aren't in your codebase
|
|
|
|
|
|
+> 👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable and testable API docs, there's some more things you need to know. So I made [a course](https://apidocsfordevs.com?utm_source=scribe-laravel&utm_medium=referral&utm_campaign=none) for you.🤗
|
|
|
+
|
|
|
## Documentation
|
|
|
Check out the documentation at [scribe.knuckles.wtf/laravel](http://scribe.knuckles.wtf/laravel).
|
|
|
|