From d7da7d2d43010d264f97237de41bb5ece3d5d369 Mon Sep 17 00:00:00 2001 From: xeruf <27jf@pm.me> Date: Tue, 29 Oct 2024 12:08:39 +0100 Subject: [PATCH] Revise Readme Wording --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 38d96719..2305372e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ # nostr.build This repository contains source code for the https://nostr.build media hosting platform. -This platform is currently hosted on AWS servers and used to provide media hosting to the nostr social media network and related applications, but can easily be hosted on any other server and used to host media for any other service or platform. +This platform is currently running on AWS servers and used to provide media hosting to the nostr social media network and related applications, +but can easily run elsewhere and host media for any other service or platform. ## How to use nostr.build -nostr.build is a free to use media hosting platform that allows users to upload images, gifs, videos and audio to nostr.build servers, and returns a link that can be used to share the uploaded media. +nostr.build is a free to use media hosting platform that allows users to upload images, gifs, videos and audio to nostr.build servers, +returing a link to share the uploaded media. -It is easy to use, simply go to https://nostr.build using your favorise browser (ex. Chrome, Safari, Brave), select the media you want to upload by either drag-and-dropping it on the website, or the 'Select Media' button, and nostr.build will return a link that can be used to add to nostr notes, or anywhere you want to share the image. +Simply go to https://nostr.build using your favorite browser, select the media you want to upload by either drag-and-dropping it on the website, or the 'Select Media' button, +and nostr.build returns a link that to add to nostr notes or share the image anywhere. @@ -17,25 +20,29 @@ Other free services include: - User profile pics cropped to the correct size for nostr and other social media platforms - EXIF (metadata) striping from images - Curated list of nostr related memes and content from over 40 nostr Creators -For the free, public version of nostr.build all use and media uploaded has to be legal and align to the nostr.build Terms of Service (https://nostr.build/tos). If used on another server using a different name, media and content guidelines can align to that hosting platform and owner -nostr.build provides an account system for users that want to have fewer limits to the media they are uploading and a place to store their media. Currently https://nostr.build charges a small fee for these accounts to cover server costs, but someone using the code for their own project can use the account system however they want. +For the free, public version of nostr.build all use and media uploaded has to be legal and align to the [nostr.build Terms of Service](https://nostr.build/tos). +If used on another server using a different name, media and content guidelines can align to that hosting platform and owner. + +nostr.build provides an account system for users that want to have fewer limits to the media they are uploading and a place to store their media. +Currently https://nostr.build charges a small fee for these accounts to cover server costs, but someone using the code for their own project can use the account system however they want. ## API -nostr.build provides a free API to publically facing nostr or bitcoin projects that offer their service for free. Please contact either nostr.build or fishcake if interested in using the API. +nostr.build provides a free API to publically facing nostr or bitcoin projects that offer their service for free. +Please contact either nostr.build or fishcake if interested in using the API. -## Customization Considerations +## Customization Considerations If installing this code on your own platform, the below are some examples of things that can be easily customized for a different experience. - Change upload limit from 5MB to a larger or smaller value -- Add or remove certain media options. Maybe make this 'image only' or 'video only' +- Add or remove certain media options - such as 'image only' or 'video only' - Change Account options to align to your platform - Change the html look and feel of the website -- Change where media is stored. Currently https://nostr.build stores all media on the AWS S3. This can be changed. +- Change where media is stored - currently https://nostr.build stores all media on AWS S3 ## Contributions and Contacts