Skip to content

Commit

Permalink
* add MIT license
Browse files Browse the repository at this point in the history
* update REFERENCES.md
* update README.md with a community and funding section
  • Loading branch information
Sebastix committed May 21, 2024
1 parent b603582 commit cc4df69
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 6 deletions.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2023-present Sebastian Hagens
Copyright (c) 2023-present nostr-php contributors - https://github.com/swentel/nostr-php/graphs/contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
This is a PHP Helper library for Nostr.
More info about Nostr: https://github.com/nostr-protocol/nostr.

If you need any help, please join this Telegram group: https://t.me/nostr_php

## Installation

To use in your project with Composer:
Expand Down Expand Up @@ -171,6 +169,14 @@ private key on command line.
- [ ] Support NIP-50 search capability
- [ ] Support multi-threading for handling requests simultaneously

## Community

If you need any help, please join this Telegram group: https://t.me/nostr_php

## Funding

In May 2024 OpenSats granted Sebastian Hagens for further development of this library for one year. If you would like to support this project with a donation, you could send some lightning sats to `[email protected]` or on-chain to `bc1p3p6jq2sxsf650lgllv57st9h97xj37fflg5t8d265saz6yqzcdyqd7pzun`.

## Maintainers

* [@sebastix](https://github.com/Sebastix) `npub1qe3e5wrvnsgpggtkytxteaqfprz0rgxr8c3l34kk3a9t7e2l3acslezefe`
Expand Down
5 changes: 3 additions & 2 deletions REFERENCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Using nostr-php:
* https://github.com/fabianfabian/nostr-media (is using a fork for PHP8.0 compatibility)
* https://github.com/OpenAgentsInc/openagents

List with other helper libraries in different languages for Nostr.
List with other helper libraries in different languages for Nostr:

* https://github.com/fiatjaf/go-nostr
* https://github.com/nbd-wtf/go-nostr
* https://github.com/rust-nostr/nostr
* https://github.com/KiPSOFT/nostr-deno
* https://github.com/holgern/pynostr
Expand All @@ -16,6 +16,7 @@ List with other helper libraries in different languages for Nostr.
* https://github.com/kawax/laravel-nostr
* https://github.com/nbd-wtf/nostr-tools
* https://github.com/dtonon/nostr-ruby
* https://github.com/penpenpng/rx-nostr

### Used resources

Expand Down
5 changes: 3 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"name": "swentel/nostr-php",
"description": "Nostr helper library for PHP",
"homepage": "https://github.com/swentel/nostr-php",
"license": "GPL-2.0-or-later",
"keywords": ["nostr", "library", "dev"],
"homepage": "https://nostr-php.dev",
"license": "MIT",
"authors": [
{
"name": "Sebastian Hagens",
Expand Down

0 comments on commit cc4df69

Please sign in to comment.