Skip to content

Commit e4598a0

Browse files
jchiarullijchiarulli
committed
feat: update readme, add funding file, and add gitignore file
1 parent 852cde9 commit e4598a0

File tree

3 files changed

+183
-2
lines changed

3 files changed

+183
-2
lines changed

‎.github/FUNDING.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: [christianchiarulli, jchiarulli]
4+
patreon: chrisatmachine

‎.gitignore

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*
131+
132+
# Ignore .DS_Store files
133+
.DS_Store

‎README.md

+46-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
1-
# relays
2-
Used to host Nostr relay binaries
1+
<div align="center"><p>
2+
<h1>Relays 📡</h1>
3+
<a href="https://github.com/nodetec/relays/releases/latest">
4+
<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" />
5+
</a>
6+
<a href="https://github.com/nodetec/relays/pulse">
7+
<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"/>
8+
</a>
9+
<a href="https://github.com/nodetec/relays/stargazers">
10+
<img alt="Stars" src="https://img.shields.io/github/stars/nodetec/relays?style=for-the-badge&logo=starship&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
11+
</a>
12+
<a href="https://github.com/nodetec/relays/issues">
13+
<img alt="Issues" src="https://img.shields.io/github/issues/nodetec/relays?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
14+
</a>
15+
<a href="https://github.com/nodetec/relays">
16+
<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" />
17+
</a>
18+
</div>
19+
20+
Relays is used to host Nostr relay binaries.
21+
22+
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.
23+
24+
## Download
25+
26+
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.
27+
28+
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.
29+
30+
## Learn More
31+
32+
If you want to learn more about how to setup a relay from scratch, check out [Relay Runner](https://relayrunner.org)
33+
34+
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:
35+
36+
- [Get a server](https://relayrunner.org/server/get-a-server)
37+
38+
- [Get a domain](https://relayrunner.org/server/domain-name)
39+
40+
- [Remote access](https://relayrunner.org/server/remote-access)
41+
42+
You should then be able to run the installation command above and get started.
43+
44+
## Contribute
45+
46+
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.

0 commit comments

Comments
 (0)