Skip to content
This repository has been archived by the owner on Aug 5, 2021. It is now read-only.

Commit

Permalink
Update readme.md (#10) (#11)
Browse files Browse the repository at this point in the history
* Update readme.md

* Remove ToDo
  • Loading branch information
Jantho1990 authored Jun 28, 2018
1 parent dff568d commit 682c026
Showing 1 changed file with 11 additions and 28 deletions.
39 changes: 11 additions & 28 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,10 @@ A Laravel package which adds the ability to create "showcases", or view boxes wh

> Still being developed!
## Todos:
- get to 1.0
- ~add the admin section~
- ~create components for dropping in the view boxes~
- add sort order functionality within displays for trophies
- unit tests
- show trophies associated with a display on the show form
- show displays associated with a trophy on the show form
- automate including the assets in the test project
- ~add validation rule for checking template files~
- finish adding flash messages for CRUD
- Vue multiselect for trophy display select
- combine with sort order selection
- redo nav dropdowns to use scrollbars for large amounts
- 1.1
- Replace buttons with FontAwesome icons where appropriate
- add ability to use a custom auth guard
- add image uploader that takes care of uploading images to the CDN
- ~add way to mass-assign trophies to a display (instead of one at a time)~
- add Trophy Groups
- and the ability to assign all Trophy Group members to a Display
- add Display Groups
- and the ability to assign a new Trophy to all Displays in a group
## [Projects](https://github.com/BrokerExchange/Showcase/projects):

- [ ] [Roadmap](https://github.com/BrokerExchange/Showcase/projects/1)


## Installation

Expand All @@ -37,8 +18,10 @@ composer require brokerexchange/showcase
```

To include the assets, you have two options:
1. `@import "vendor/brokerexchange/showcase/resources/assets/build/public";` in your main stylesheet, which will include the styles as part of your app's compiled styles.
2. `php artisan vendor:publish --tag=showcase-assets` and link to `/vendor/showcase/public.css` in the `<head>`.

1. `@import "vendor/brokerexchange/showcase/resources/assets/build/public";` in your main stylesheet, which will include the styles as part of your app's compiled styles.

2. `php artisan vendor:publish --tag=showcase-assets` and link to `/vendor/showcase/public.css` in the `<head>`.

If you want to publish all the assets:
```
Expand Down Expand Up @@ -70,8 +53,8 @@ To update the test project with package changes:
This will also dump composer's autoload and clear the Laravel cache and compiled views.

Flags you can use:
- `--migrations`: run database migrations
- `--rundev`: run the package `npm run dev` before updating the test project
- `--migrations`: run database migrations
- `--rundev`: run the package `npm run dev` before updating the test project

#### Authentication
The test project generates Auth during the build. A default user is created with the test project:
Expand Down Expand Up @@ -140,4 +123,4 @@ There are some configuration options exposed for you in the config file `showcas
By default, all showcase tables are prefixed with `showcase_`. You may change this to whatever you desire.

#### Middleware
By default, all admin routes for Showcase are passed through `web` and `auth`. You may change this array in config to add or remove middleware as you want.
By default, all admin routes for Showcase are passed through `web` and `auth`. You may change this array in config to add or remove middleware as you want.

0 comments on commit 682c026

Please sign in to comment.