maierfelix / maierfelix/POGOserver

Enhanced Readme File

Open
#7 5 comments 0 reactions 0 assignees View on GitHub
Enhancement
Dominant language
JavaScript
Stars
476
Forks
198
PR merge metrics
No merged PRs in 30d

Description

Hello,
An an enhanced readme file would be nice with full tutorial on how to successfully launch this server and get it working and be able to actually use it. Advanced users, yes may be able to get this working, however regular users could use a bit more of an indepth readme.

I'd also like to see a server be used with multiple users on it, and possibly a tutorial on how to allow other users to access this without such an extenuating process for an everyday user.

Good work!,

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing README and the server's current setup and usage instructions. Expand the documentation to cover launching the server, using it as a regular user, and allowing multiple users to access it; done means a newcomer can follow the tutorial successfully without the existing complicated process.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.