replit-py icon indicating copy to clipboard operation
replit-py copied to clipboard

Update README.md

Open techpixel opened this issue 3 years ago • 7 comments

In the README, I find that this is a little bit misleading.

A Flask–based application framework for accelerating development on the platform.

This change accurately represents the feature as an interface to replit:

A Flask interface to Replit's User Authetication service

techpixel avatar May 26 '22 01:05 techpixel

it's more than just auth though. can you elaborate on what is misleading?

spencerpogo avatar May 26 '22 01:05 spencerpogo

From what I can gather from the documentation, the "web" part only consists of an interface to replit auth and a few helper /wrapper functions. I can't discern any of these features from "application framework".

techpixel avatar May 26 '22 01:05 techpixel

Well "vague" is different from "misleading." I think the current wording is sufficient to "draw a user in." While I'm willing to change it, I think that your wording doesn't cover the full scope of replit.web.

spencerpogo avatar May 26 '22 02:05 spencerpogo

How about:

Tools and utilities for Flask Web Development, including an interface to Replit's User Authetication service

It points to the wrappers and helper functions while also mentioning the Auth interface.

techpixel avatar May 26 '22 16:05 techpixel

Sounds good. If you update that sentence as you mentioned I'll merge

spencerpogo avatar May 27 '22 02:05 spencerpogo

Sentence was updated and is ready to merge.

techpixel avatar May 28 '22 17:05 techpixel

Will this merge?

techpixel avatar Jul 26 '22 20:07 techpixel

Will it?

lafkpages avatar Apr 07 '23 21:04 lafkpages

It appears this library stopped getting updates near the time this PR was made, so likely not.

techpixel avatar Apr 07 '23 22:04 techpixel