Add README

README.md

@@ -0,0 +1,34 @@
+# Nostr Media for WordPress
+
+Host your images and media in your own WordPress installation using this plug-in.
+
+## Warning
+This is a very early rough initial version, just the minimal needed to get things working. Needs clean up and refactoring, extra security check, and doesn't support all the features of a fully fledged nostr backend, for that look at solutions like: https://github.com/quentintaranpino/nostrcheck-api-ts 
+
+## Features
+- Upload media using HTTP Auth (NIP98)
+- Keeps original image and generates a scaled version
+- Media will be available in your WordPress back-end on the Media page.
+
+## Installation
+1) In WordPress go to Plugins -> Add New -> Upload Plugin -> Choose nostr-media.zip -> Install Now -> Activate Plugin
+2) Go to Settings -> Permalinks -> Save Changes (don't change, just save, this will create routes needed)
+3) Go to Users -> Edit -> Nostr Media -> Public key (npub) -> Enter your npub here, this npub/user will be allowed to upload files to this WordPress installation. Click Update Profile to save.
+
+## Configuring a NIP96 compatible Nostr Client
+- Enter the URL of your WordPress installation as the File Storage Server address, eg: https://your-website.com
+- Happy uploading!
+
+
+## Troubleshooting
+- Make sure your WordPress installation allows large uploads, you can put this in your .htaccess
+```
+php_value upload_max_filesize 128M
+php_value post_max_size 128M
+```
+
+
+## Development
+1) git clone this repository
+2) run ```composer install```
+3) Copy entire folder to your WordPress plugins directory