README
¶
🌐 nostrfetch
Share your Nostr profile in your screenshots on r/unixporn
📝 Notes
- Profile preview is only supported on Kitty terminal emulator.
- The image preview is displayed on top of the text rather than to the side; this is a feature, not a bug.
🚀 Installation
You can download pre-built binaries for various operating systems from the releases page.
Alternatively, you can build the application from source by following the instructions in the next section.
🔨 Build from Source
To build nostrfetch from source, follow these steps:
- Clone the repository:
git clone https://github.com/MAHcodes/nostrfetch.git - Navigate to the project directory:
cd nostrfetch - Install dependencies:
go get ./... - Build the application:
go build -o nostrfetch main.go
This will build the nostrfetch binary in the current directory.
You can also use go install to install the binary to your $GOPATH/bin directory:
go install .
This will install the nostrfetch binary to $GOPATH/bin.
Note that building from source requires Go to be installed on your machine. You can download the latest version of Go from the official website.
📖 Usage
- Create a configuration file at
$XDG_CONFIG_HOME/nostrfetch/config.yaml. If$XDG_CONFIG_HOMEis not set, you can use~/.configinstead.
Here's an example configuration file:
# The URL of the Nostr relay to use
relayURL: wss://relay.damus.io
# The npub public key for the profile you want to fetch
npub: npub1qd3hhtge6vhwapp85q8eg03gea7ftuf9um4r8x4lh4xfy2trgvksf6dkva
- Run
nostrfetch
👥 Contributing
Pull requests are welcome! Please follow these guidelines:
- Fork the repo
- Create a new branch for your feature (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new pull request
📝 License
This project is licensed under the terms of the GNU General Public License v3.0.
🧑 Authors
🙏 Acknowledgments
Documentation
¶
There is no documentation for this package.
Source Files