Added README.md
This commit is contained in:
commit
752a90b9ae
1 changed files with 38 additions and 0 deletions
38
README.md
Normal file
38
README.md
Normal file
|
@ -0,0 +1,38 @@
|
||||||
|
# Cyber Circle Creator
|
||||||
|
|
||||||
|
Yo choom! I'm excited to introduce you to [Cyber Circle Creator](https://ccc.cyber.to), a preem tool that I forked and enhanced. It allows you to explore your Fediverse circle with a cyberpunk twist!
|
||||||
|
|
||||||
|
## What's It About?
|
||||||
|
|
||||||
|
Cyber Circle Creator lets you visualize your Fediverse connections in a dynamic, cyber-futuristic way. Just pop in your Fediverse handle, and watch your network come to life in an interactive diagram.
|
||||||
|
|
||||||
|
This tool builds upon [AMNatty/Mastodon-Circles](https://github.com/AMNatty/Mastodon-Circles) and [andigandhi/Mastodon-Circles](https://github.com/andigandhi/Mastodon-Circles), with some enhancements from [noellabo](https://github.com/noellabo/Mastodon-Circles) including Fedibird support.
|
||||||
|
|
||||||
|
## What Can You Do With It?
|
||||||
|
|
||||||
|
- **Visualize Your Network**: Enter your Mastodon or another Fediverse handle to see a graphical display of your connections.
|
||||||
|
- **Cyberpunk Style**: Enjoy visuals with dynamic lines and intricate, sci-fi-inspired backgrounds.
|
||||||
|
- **Instant Sharing**: Create a link with your handle to easily share your unique circle with others.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
It's super easy to get started! Just head over to [Cyber Circle Creator](https://ccc.cyber.to) and enter your Fediverse handle. For quick access next time, modify the URL directly by appending your handle like so: `https://ccc.cyber.to/?@username@instance.tld`.
|
||||||
|
|
||||||
|
## Customization Options
|
||||||
|
|
||||||
|
Make it your own with customization features! You can tweak line colors, avatar sizes, and add cool background patterns. Customization is available via the `config` object in `js/image.js`.
|
||||||
|
|
||||||
|
Here's a quick overview of what you can change:
|
||||||
|
|
||||||
|
- **`logoSrc`**: Path to your project’s logo image.
|
||||||
|
- **`backgroundColor`**: Set the background color of your canvas.
|
||||||
|
- **`lineColor`**: Choose the color of the connection lines.
|
||||||
|
- **Etc.**: There are many more options to play around with if you’re up for some customization.
|
||||||
|
|
||||||
|
## Need Help?
|
||||||
|
|
||||||
|
Got questions or need some help? Check out the [FAQ section](https://ccc.cyber.to) on the project site for more info or contact me in the Fediverse. [Fediverse](https://corteximplant.com/@revengeday)
|
||||||
|
|
||||||
|
## Contribute!
|
||||||
|
|
||||||
|
Interested in contributing? That would be awesome! Feel free to create a fork. Let's see what amazing things you can contribute!
|
Loading…
Reference in a new issue