Skip to content

README could state the relationship to the original recceiver #6

Description

@anderslindho

This repository shares its name with the original Python/Twisted recceiver that
has lived in ChannelFinder/recsync under ./server since the project started, and
which is what most current deployments run. Both are servers for the same
protocol, so the name fits both, but a reader arriving here has no way to tell
which one they have found.

Could the README say near the top that this is a Java/Spring Boot implementation
of the RecSync server, and link to
https://github.com/ChannelFinder/recsync/tree/master/server for the original
implementation? A sentence or two would be enough. It would help anyone looking
for source, a release, or somewhere to report a problem with the server they are
actually running.

I have opened ChannelFinder/recsync#174 about how the repository split should be
completed, which covers the naming question itself. This issue is only about the
README while that is open.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions