Ruby gem for ingesting ATProto repo data from a Tap service (extension of Skyfall gem)
added placeholder readme
+9
-24
+9
-24
README.md
+9
-24
README.md
···
1
1
# Tapfall
2
2
3
-
TODO: Delete this and the text below, and describe your gem
3
+
A Ruby gem for ingesting ATProto repository data from a [Tap](https://github.com/bluesky-social/indigo/tree/main/cmd/tap) service (extension of the [Skyfall](https://tangled.org/mackuba.eu/skyfall) gem).
4
4
5
-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tapfall`. To experiment with that code, run `bin/console` for an interactive prompt.
5
+
> [!NOTE]
6
+
> Part of ATProto Ruby SDK: [ruby.sdk.blue](https://ruby.sdk.blue)
6
7
7
-
## Installation
8
8
9
-
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
9
+
## What does it do
10
10
11
-
Install the gem and add to the application's Gemfile by executing:
11
+
...... TODO ......
12
12
13
-
```bash
14
-
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
15
-
```
16
13
17
-
If bundler is not being used to manage dependencies, install the gem by executing:
14
+
## Credits
18
15
19
-
```bash
20
-
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
21
-
```
22
-
23
-
## Usage
24
-
25
-
TODO: Write usage instructions here
26
-
27
-
## Development
16
+
Copyright © 2025 Kuba Suder ([@mackuba.eu](https://bsky.app/profile/did:plc:oio4hkxaop4ao4wz2pp3f4cr)).
28
17
29
-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
-
31
-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
-
33
-
## Contributing
18
+
The code is available under the terms of the [zlib license](https://choosealicense.com/licenses/zlib/) (permissive, similar to MIT).
34
19
35
-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tapfall.
20
+
Bug reports and pull requests are welcome 😎