Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
add new badges
add new screenshots
introduce compatibility matrix
  • Loading branch information
warlof committed Dec 28, 2021
1 parent 0cfba64 commit 5606b7f
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 13 deletions.
47 changes: 34 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
# eveseat-calendar
[![Latest Stable Version](https://img.shields.io/packagist/v/kassie/calendar.svg?style=flat-square)](https://packagist.org/packages/kassie/calendar)
[![Next Version](https://img.shields.io/packagist/vpre/kassie/calendar.svg?style=flat-square)](https://packagist.org/packages/kassie/calendar)
[![License](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat-square)](https://raw.githubusercontent.com/warlof/slackbot/master/LICENSE)

Calendar plugin for EVE SeAT 2.x and 3.x
[![Latest Stable Version](https://img.shields.io/packagist/v/kassie/calendar.svg?style=for-the-badge)](https://packagist.org/packages/kassie/calendar)
[![Next Version](https://img.shields.io/packagist/vpre/kassie/calendar.svg?style=for-the-badge)](https://packagist.org/packages/kassie/calendar)
[![Downloads](https://img.shields.io/packagist/dt/kassie/calendar?style=for-the-badge)](https://packagist.org/packages/BenHUET/eveseat-calendar)
[![Core Version](https://img.shields.io/badge/SeAT-4.0.x-blueviolet?style=for-the-badge)](https://github.com/eveseat/seat)
[![License](https://img.shields.io/github/license/BenHUET/eveseat-calendar?style=for-the-badge)](https://github.com/BenHUET/eveseat-calendar/blob/master/LICENCE)

Calendar plugin for EVE SeAT

# Features

* Create/Update/Cancel/Delete/Close & Tag operations
* Register to operations
* Slack integration
* Permissions

# Release

https://packagist.org/packages/kassie/calendar

# Compatibility

| SeAT Core | Calendar | Branch |
| --------- | -------- | ---------------------------------------------------------------- |
| 2.x | 1.x | [2.0.x](https://github.com/BenHUET/eveseat-calendar/tree/2.0.x) |
| 3.x | 3.x | [3.0.x](https://github.com/BenHUET/eveseat-calendar/tree/3.0.x) |
| 4.x | 4.x | [master](https://github.com/BenHUET/eveseat-calendar) |

# Installation

* `composer require kassie/calendar` in the SeAT root directory
* `php artisan vendor:publish --force`
* `php artisan migrate`
Expand All @@ -23,30 +37,37 @@ https://packagist.org/packages/kassie/calendar
* `php artisan db:seed --class=Seat\\Kassie\\Calendar\\database\\seeds\\ScheduleSeeder`

## Since 1.3.2

Since 1.3.2, the PAP mechanism has been implemented. You need `esi-fleets.read_fleet.v1` into your requested scopes list.

# Feedbacks or support

@kassie_yvo on eve-seat.slack.com
[email protected]
Kassie Yvo in-game

If you like this module, consider giving some ISK, I'm space poor.

# Screenshots (out of date)
# Screenshots

## Main display
![Main display](http://i.imgur.com/UXr9LfX.png "Main display")

## Details of an operation
![Details of an operation](http://i.imgur.com/TNZMp4t.png "Details of an operation")
![Main display](./img/main_display.png "Main display")

## Details of an operation

![Details of an operation](./img/operation_details.png "Details of an operation")

## Customize your tags
![Customize your tags](http://i.imgur.com/byVK549.png "Customize your tags")
## Customize your tags

![Customize your tags](./img/tags_creation.png "Customize your tags")
![Customize your tags](./img/tags_management.png "Manage your tags")

## Slack integration

## Slack integration
![Slack integration](http://i.imgur.com/zV2w9sx.png "Slack integration")

## Pap feature

![Paps charts](https://user-images.githubusercontent.com/648753/34275321-0af18d90-e69d-11e7-9a93-31c07f4b303c.png "Paps charts")
![Paps character tracking](https://user-images.githubusercontent.com/648753/34328226-dc165886-e8d9-11e7-8084-731b0d674f8d.png "Paps character tracking")
![Bind FC](https://user-images.githubusercontent.com/648753/34275364-4af34726-e69d-11e7-8349-8ecd9d785161.png)
![Paps fleet as FC](https://user-images.githubusercontent.com/648753/34275326-17840196-e69d-11e7-8c2e-7a86c7632bf9.png)
Binary file added img/main_display.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/operation_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/tags_creation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/tags_management.png
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 5606b7f

Please sign in to comment.