feat: update readme, add funding file, and add gitignore file

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [christianchiarulli, jchiarulli]
+patreon: chrisatmachine

.gitignore

@@ -0,0 +1,133 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# Ignore .DS_Store files
+.DS_Store

README.md

@@ -1,2 +1,46 @@
-# relays
-Used to host Nostr relay binaries
+<div align="center"><p>
+    <h1>Relays 📡</h1>
+    <a href="https://github.com/nodetec/relays/releases/latest">
+      <img alt="Latest release" src="https://img.shields.io/github/v/release/nodetec/relays?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41" />
+    </a>
+    <a href="https://github.com/nodetec/relays/pulse">
+      <img alt="Last commit" src="https://img.shields.io/github/last-commit/nodetec/relays?style=for-the-badge&logo=starship&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
+    </a>
+    <a href="https://github.com/nodetec/relays/stargazers">
+      <img alt="Stars" src="https://img.shields.io/github/stars/nodetec/relays?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
+    </a>
+    <a href="https://github.com/nodetec/relays/issues">
+      <img alt="Issues" src="https://img.shields.io/github/issues/nodetec/relays?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
+    </a>
+    <a href="https://github.com/nodetec/relays">
+      <img alt="Repo Size" src="https://img.shields.io/github/repo-size/nodetec/relays?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
+    </a>
+</div>
+
+Relays is used to host Nostr relay binaries.
+
+The binaries have been tested with and are used by [Relay Wizard](https://github.com/nodetec/relaywizard) which is a CLI tool that helps you bootstrap a [Nostr](https://nostr.com/) relay.
+
+## Download
+
+To download a relay binary navigate to the [Releases](https://github.com/nodetec/relays/releases) page and click on the binary you want to download.
+
+Alternatively, you can use Relay Wizard which will download the binary for your preferred relay implementation as well as bootstrap the rest of the relay.
+
+## Learn More
+
+If you want to learn more about how to setup a relay from scratch, check out [Relay Runner](https://relayrunner.org)
+
+If you just want to know enough to get started, read the following sections to get a server, hook up a domain name and setup remote access:
+
+- [Get a server](https://relayrunner.org/server/get-a-server)
+
+- [Get a domain](https://relayrunner.org/server/domain-name)
+
+- [Remote access](https://relayrunner.org/server/remote-access)
+
+You should then be able to run the installation command above and get started.
+
+## Contribute
+
+If you want to contribute consider testing the binaries by setting up your own relays, by following the Relay Runner guides, and by using Relay Wizard.