Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
duncanmcclean committed Jan 14, 2023
1 parent 20b176f commit d5e15b0
Show file tree
Hide file tree
Showing 4 changed files with 96 additions and 16 deletions.
102 changes: 86 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,86 @@
![Banner](./banner.png)
<!-- statamic:hide -->

## Runway
<p align="center">
<picture>
<source srcset="./logo-dark.svg" media="(prefers-color-scheme: dark)">
<img align="center" width="250" height="70" src="./logo-default.svg">
</picture>
</p>
<br>

<!-- /statamic:hide -->

Runway gives you the ability to display & manage your Eloquent models in Statamic.

> "With Runway I was able to quickly make a beautiful admin panel that administrators can use. If Runway didn't exist, it would have taken me a week or two to build something that wasn't quite as nice. Thanks for saving me days and days of work Duncan!"
>
> **[Erin Dalzell, Certified Statamic Partner](https://silentz.co)**
[Read the docs](https://runway.duncanmcclean.com).

## Features

- Control Panel integration
- Front-end Routing
- Antlers Tags
- GraphQL API
### Control Panel integration

Runway fits right into the Control Panel - enabling you to create, edit and view your models. In most cases, you'll not notice the difference between an entry in the CP and an Eloquent model in the CP.

- [Review documentation](https://runway.duncanmcclean.com/control-panel)

### Front-end routing

Need to show your models on the front-end of your site? No problem - Runway's got that under control. Simply tell Runway the route you'd like to use and it'll serve up the front-end for you.

```php
// config/runway.php

return [
'resources' => [
\App\Models\Product::class => [
'route' => '/products/{{ slug }}',
],
],
];
```

- [Review documentation](https://runway.duncanmcclean.com/frontend-routing)

### Antlers templating

## Documentation
In addition to front-end routing, you may also use Runway's tag to loop through your models and display the results. The tag supports filtering, using Eloquent scopes and sorting.

Visit the [Runway website](https://runway.duncanmcclean.com/) to read the documentation & knowledge base articles.
```antlers
{{ runway:products }}
<h2>{{ name }}</h2>
<p>Price: {{ price }}</p>
{{ /runway:products }}
```

- [Review documentation](https://runway.duncanmcclean.com/templating)

### GraphQL API

If you're a GraphQL fan, you're now able to fetch your models via GraphQL. Runway will augment the fields just like you'd expect.

```graphql
{
products(limit: 25, sort: "name") {
data {
id
name
price
description
}
}
}
```

## Support

Runway is a free addon, because of this there is no direct support channel. If you have a feature request or experience a bug, please [open a GitHub Issue](https://github.com/duncanmcclean/runway/issues/new/choose) and it'll be looked into over the next week or two.
If you find a bug, have some question or have a feature request, please open a [GitHub Issue or Discussion](https://github.com/duncanmcclean/runway/issues/new/choose).

> Please note: only the latest version of this addon is supported. Any bug reports regarding an old version will be closed.
> Only the latest version of this addon is supported. If you open a bug report using an old version, your issue will be closed.
<!-- statamic:hide -->

## Sponsor me!

Expand All @@ -29,10 +90,19 @@ However, there is a cost from my perspective to maintain this addon (fixing new

If you use this software on your projects & can afford it, I'd appreciate it if you'd consider [sponsoring me](https://github.com/sponsors/duncanmcclean), even if it's just a couple dollars a month.

---
## Contributing

<p>
<a href="https://statamic.com"><img src="https://img.shields.io/badge/Statamic-3.3+-FF269E?style=for-the-badge" alt="Compatible with Statamic v3"></a>
<a href="https://packagist.org/packages/doublethreedigital/runway/stats"><img src="https://img.shields.io/packagist/v/doublethreedigital/runway?style=for-the-badge" alt="Runway on Packagist"></a>
<a href="https://tuple.app"><img src="https://img.shields.io/badge/Pairing%20with-Tuple-5A67D8?style=for-the-badge" alt="Pairing with Tuple"></a>
</p>
Contributions are welcome, and are accepted via pull requests. You should follow this process when contributing:

1. Fork the repository
2. Make your code change
3. Open a pull request, detailing the changes you've made.
4. Ensure StyleCI isn't reporting any code-style errors. If it is, you should resolve those.

If your pull request is a Work in Progress, please mark your pull request as a draft.

## Security

If you've found a bug regarding security please email security@doublethree.digital instead of using the issue tracker.

<!-- /statamic:hide -->
Binary file removed banner.png
Binary file not shown.
5 changes: 5 additions & 0 deletions logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions logo-default.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d5e15b0

Please sign in to comment.