Skip to content

Commit 25834c8

Browse files
committed
Update README
1 parent 3d8088f commit 25834c8

6 files changed

Lines changed: 47 additions & 176 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 0 additions & 142 deletions
This file was deleted.

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
44
patreon: # Replace with a single Patreon username
55
open_collective: userfrosting # Replace with a single Open Collective username
6-
ko_fi: # Replace with a single Ko-fi username
6+
ko_fi: lcharette # Replace with a single Ko-fi username
77
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
88
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
99
liberapay: # Replace with a single Liberapay username

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,2 @@
11
🛑 STOP!
2-
3-
Before you open an issue:
4-
5-
1. Make sure that your issue is a BUG or FEATURE REQUEST. General usage and troubleshooting questions should be directed to the [forums](https://forums.userfrosting.com), [chat](https://chat.userfrosting.com), or [Stack Overflow](https://stackoverflow.com/questions/tagged/userfrosting). You can also consult our chapter on [common problems](https://learn.userfrosting.com/troubleshooting/common-problems). Issues asking for general support WILL BE CLOSED automatically.
6-
2. Search the forums and current issues, both open and closed, for a similar issue. If the bug is still present but the relevant issue has been closed, you may ask us to reopen the issue. Duplicate issues will be closed automatically.
7-
3. Make sure that you are using the latest stable version of UserFrosting (see the [release history](https://github.com/userfrosting/UserFrosting/releases)). Support for UserFrosting 3.x or earlier may be limited.
8-
9-
If you are CERTAIN that it is appropriate to open a new issue, you must:
10-
11-
1. Format any code snippets or command-line output using Markdown [code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/), and make sure your code is properly indented. **This is extremely important** - poorly formatted code is difficult to read and reflects badly on you as a programmer.
12-
2. Remember that courtesy and proper grammar go a long way. Please take the time to craft a precise, polite issue. We will do our best to help, but remember that this is an open-source project - none of us are getting paid a salary to develop this project, or act as your personal support hotline ;-)
13-
1. State the steps needed to reproduce the problem.
14-
2. Mention your version of UserFrosting, as well as the browser(s) and operating system(s) in which the problem occurs.
15-
3. Report any errors in detail. Vague issues like "it doesn't work when I do this" are not helpful. Show that you have put some effort into identifying the cause of the error. See the section on [debugging](https://learn.userfrosting.com/troubleshooting/debugging) for information on how to get more details about errors and other problems.
16-
3. You should always test your code in a local development environment, to separate code-related issues from server issues. In general, we recommend that you install a local development server on your computer, rather than testing your code directly on the production server. This means you can test your code directly on your own computer, making development faster and without the risk of exposing sensitive information to the public. We recommend installing Vagrant and Homestead if you don't already have a local server set up.
17-
4. If you are not conversationally proficient in English, do NOT just post a machine translation (e.g. Google Translate) to GitHub. Get help in crafting your question, either via the [forums](https://forums.userfrosting.com) or in [chat](https://chat.userfrosting.com). If all else fails, you may post your bug report or feature request in your native language, with a machine translation below that. We will tag it with `translation-needed` so that others who speak your language can find it.
18-
5. Clear out this placeholder text.
19-
6. Consider supporting this project by [making a donation to our Open Collective](https://opencollective.com/userfrosting/donate)!
2+
Issues should be opened on the main repo : https://github.com/userfrosting/UserFrosting/issues

README.md

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# UserFrosting AdminLTE Theme
2-
Admin LTE Theme for UserFrosting 5
2+
AdminLTE Theme for UserFrosting 5
33

44
[![Version](https://img.shields.io/github/v/release/userfrosting/theme-adminlte?sort=semver)](https://github.com/userfrosting/theme-adminlte/releases)
55
![PHP Version](https://img.shields.io/badge/php-%5E8.0-brightgreen)
@@ -8,20 +8,50 @@ Admin LTE Theme for UserFrosting 5
88
[![Codecov](https://codecov.io/gh/userfrosting/theme-adminlte/branch/main/graph/badge.svg)](https://app.codecov.io/gh/userfrosting/theme-adminlte/branch/main)
99
[![StyleCI](https://github.styleci.io/repos/445386142/shield?branch=main&style=flat)](https://github.styleci.io/repos/445386142)
1010
[![PHPStan](https://img.shields.io/github/actions/workflow/status/userfrosting/theme-adminlte/PHPStan.yml?branch=main&label=PHPStan)](https://github.com/userfrosting/theme-adminlte/actions/workflows/PHPStan.yml)
11-
[![Donate](https://img.shields.io/badge/Open%20Collective-Donate-blue.svg)](https://opencollective.com/userfrosting#backer)
11+
[![Donate](https://img.shields.io/badge/Open_Collective-Donate-blue?logo=Open%20Collective
12+
)](https://opencollective.com/userfrosting#backer)
13+
[![Donate](https://img.shields.io/badge/Ko--fi-Donate-blue?logo=ko-fi&logoColor=white
14+
)](https://ko-fi.com/lcharette)
15+
16+
## By [Alex Weissman](https://alexanderweissman.com) and [Louis Charette](https://bbqsoftwares.com)
17+
18+
Copyright (c) 2019-2023, free to use in personal and commercial software as per the [license](LICENSE.md).
19+
20+
UserFrosting is a secure, modern user management system written in PHP and built on top of the [Slim Microframework](http://www.slimframework.com/), [Twig](http://twig.sensiolabs.org/) templating engine, and [Eloquent](https://laravel.com/docs/5.8/eloquent#introduction) ORM.
21+
22+
The AdminLTE theme sprinkle contains all the twig files and frontend asset to implement the [AdminLTE template](https://adminlte.io/).
1223

1324
## Installation
14-
```
15-
composer require userfrosting/theme-adminlte
16-
```
25+
1. Require in your [UserFrosting](https://github.com/userfrosting/UserFrosting) project :
26+
```
27+
composer require userfrosting/theme-adminlte
28+
```
1729
18-
Add `UserFrosting\Theme\AdminLTE\AdminLTE` to your Sprinkle Recipe.
30+
2. Add the Sprinkle to your Sprinkle Recipe :
31+
```php
32+
public function getSprinkles(): array
33+
{
34+
return [
35+
\UserFrosting\Theme\AdminLTE\AdminLTE::class,
36+
];
37+
}
38+
```
39+
40+
3. Bake
41+
```bash
42+
php bakery bake
43+
```
44+
45+
## Documentation
46+
See main [UserFrosting Documentation](https://learn.userfrosting.com) for more information.
1947
20-
## See Also
2148
- [Changelog](CHANGELOG.md)
22-
- [License](LICENSE)
23-
- [Style Guide](.github/STYLE-GUIDE.md)
24-
- [Testing](.github/RUNNING_TESTS.md)
49+
- [Issues](https://github.com/userfrosting/UserFrosting/issues)
50+
- [License](LICENSE.md)
51+
- [Style Guide](STYLE-GUIDE.md)
52+
53+
## Contributing
54+
55+
This project exists thanks to all the people who contribute. If you're interested in contributing to the UserFrosting codebase, please see our [contributing guidelines](https://github.com/userfrosting/UserFrosting/blob/5.0/.github/CONTRIBUTING.md) as well as our [style guidelines](.github/STYLE-GUIDE.md).
2556
26-
## References
27-
- https://adminlte.io
57+
[![](https://opencollective.com/userfrosting/contributors.svg?width=890&button=true)](https://github.com/userfrosting/sprinkle-core/graphs/contributors)

app/locale/en_US/messages.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
'VERIFY' => 'Verify the captcha',
2424
],
2525

26-
'CSRF_MISSING' => 'Missing CSRF token. Try refreshing the page and then submitting again?',
26+
'CSRF_MISSING' => 'Missing CSRF token. Try refreshing the page and then submitting again?',
2727

28-
'DB_INVALID' => 'Cannot connect to the database. If you are an administrator, please check your error log.',
28+
'DB_INVALID' => 'Cannot connect to the database. If you are an administrator, please check your error log.',
2929
'DESCRIPTION' => 'Description',
3030
'DOWNLOAD' => [
3131
'@TRANSLATION' => 'Download',

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "userfrosting/theme-adminlte",
33
"type": "userfrosting-theme",
44
"description": "AdminLTE theme for UserFrosting 5",
5-
"keywords": ["php user management", "AdminLTE", "webpack", "UserFrosting"],
5+
"keywords": ["php user management", "AdminLTE", "webpack", "UserFrosting", "theme", "userfrosting-sprinkle", "userfrosting-theme"],
66
"homepage": "https://github.com/userfrosting/UserFrosting",
77
"license" : "MIT",
88
"authors" : [

0 commit comments

Comments
 (0)