Skip to content

Commit d61b93a

Browse files
committed
Doc and funding
1 parent 0a8c833 commit d61b93a

File tree

3 files changed

+18
-25
lines changed

3 files changed

+18
-25
lines changed

Diff for: .github/CONTRIBUTING.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,11 @@ Bugs or feature requests can be posted online on the GitHub issues section of th
66

77
Few rules to ease code reviews and merges:
88

9-
- You MUST follow the [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr/psr-2/) and [PSR-4](http://www.php-fig.org/psr/psr-4/) coding standards.
9+
- You MUST follow the [PSR-12](http://www.php-fig.org/psr/psr-12/) coding standard.
1010
- You MUST run the test suite.
1111
- You MUST write (or update) unit tests when bugs are fixed or features are added.
1212
- You SHOULD write documentation.
1313

14-
We use [Git-Flow](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) to automate our git branching workflow.
15-
1614
To contribute use [Pull Requests](https://help.github.com/articles/using-pull-requests), please, write commit messages that make sense, and rebase your branch before submitting your PR.
1715

1816
May be asked to squash your commits too. This is used to "clean" your Pull Request before merging it, avoiding commits such as fix tests, fix 2, fix 3, etc.
19-
20-
Run test suite
21-
------------
22-
23-
* install composer: `curl -s http://getcomposer.org/installer | php`
24-
* install dependencies: `php composer.phar install`
25-
* run tests: `vendor/bin/behat`

Diff for: .github/FUNDING.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: Spomky
2+
patreon: FlorentMorselli

Diff for: README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
PHP JOSE Application
2-
==================
2+
====================
33

44
# Documentation
55

66
The official documentation is available as https://web-token.spomky-labs.com/
77

88
# Installation
99

10-
```sh
11-
curl -OL https://github.com/web-token/jwt-app/raw/gh-pages/jose.phar
12-
curl -OL https://github.com/web-token/jwt-app/raw/gh-pages/jose.phar.pubkey
13-
```
10+
You just have to download the PHAR file attached to [the release you want](https://github.com/web-token/jwt-app/releases) to use.
1411

15-
If everything is fine, you should have two files:
12+
You may need to set the file as executable:
1613

17-
* jose.phar
18-
* jose.phar.pubkey
14+
```sh
15+
chmod +x jose.phar
16+
```
1917

20-
You can move these files wherever you want (e.g. /usr/local/bin).
18+
You can distribute the file in your project or use it locally (e.g. /usr/local/bin).
2119

2220
# Support
2321

2422
I bring solutions to your problems and answer your questions.
2523

26-
If you really love that project and the work I have done or if you want I prioritize your issues, then you can help me out for a couple of :beers: or more!
24+
If you really love that project, and the work I have done or if you want I prioritize your issues, then you can help me out for a couple of :beers: or more!
25+
26+
[Become a sponsor](https://github.com/sponsors/Spomky)
27+
28+
Or
2729

2830
[![Become a Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/FlorentMorselli)
2931

3032
# Contributing
3133

32-
Requests for new features, bug fixed and all other ideas to make this framework useful are welcome.
33-
If you feel comfortable writing code, you could try to fix [opened issues where help is wanted](https://github.com/Spomky-Labs/jose/labels/help+wanted) or [those that are easy to fix](https://github.com/Spomky-Labs/jose/labels/easy-pick).
34-
35-
Do not forget to [follow these best practices](.github/CONTRIBUTING.md).
34+
Requests for new features, bug fixed and all other ideas to make this library useful are welcome. [Please follow these best practices](doc/Contributing.md).
3635

37-
**If you think you have found a security issue, DO NOT open an issue**. You should submit your issue here.
36+
If you discover a security vulnerability within the project, please **don't use the bug tracker and don't publish it publicly**.
37+
Instead, all security issues must be sent to security [at] spomky-labs.com.
3838

3939
# Licence
4040

0 commit comments

Comments
 (0)