Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

...what kind of modular toolkit, though? #118

Closed
workingjubilee opened this issue May 6, 2020 · 5 comments · Fixed by #164
Closed

...what kind of modular toolkit, though? #118

workingjubilee opened this issue May 6, 2020 · 5 comments · Fixed by #164
Labels
bug Something isn't working

Comments

@workingjubilee
Copy link

Describe the Bug

The README.md describes gloo as a "A modular toolkit for building fast, reliable Web applications and libraries with Rust and Wasm" and mentions a few example contents. But it does not give a high-level overview of gloo's contents or consequence, leaving me with only those examples, so I am not sure if it can do anything more. This requires me to consult API docs or read the source in order to find out if it will Solve My Particular Problems. I am not sure what modules it gets modular with, or what tools are in the toolkit, and while hearing that it won't try to do what other libraries do is nice, I am not sure what it does do.

It describes several aspirational goals which is fine, and a grand perspective and some ideas, but I am not really sure what specific problems that I, as a prospective wasm app builder, would use it to solve, and most of the goals are ones I would expect would be had by any Rust application or library.

Expected Behavior

Compare with https://reactjs.org/ which says, plainly, "a JavaScript library for building user interfaces" and then describes multiple features, namely: the style of the library (declarative), the goal of easy integration, and the choice to use component-based interfaces, and elaborates a little on how those are useful. A very high level description but still a bit useful if I don't know what React is.

Even better, https://jquery.com/ describes the problem it was created to address and its capabilities to address it with, with a laserlike focus. If I have felt this painpoint, ever, I would be very interested.

@workingjubilee workingjubilee added the bug Something isn't working label May 6, 2020
@Pauan
Copy link
Contributor

Pauan commented May 6, 2020

Gloo is not like React or jQuery, it is actually a collection of libraries, and those libraries can do all sorts of things: date/time, timers, DOM events, file fetching and reading, databases, server network communication, logging, Chrome/Firefox extensions, etc.

That's why it's a "toolkit" and not a "library" or "framework": it's just a collection of useful APIs. Those APIs are usually high-level wrappers around web-sys. So the best we can do for an overview is to say, "we have useful stuff". If you have any suggestions for a better overview, I'd be glad to hear it.

@workingjubilee
Copy link
Author

workingjubilee commented May 6, 2020

If you have any suggestions for a better overview, I'd be glad to hear it.

Pretty sure you just posted it!

date/time, timers, DOM events, file fetching and reading, databases, server network communication, logging, Chrome/Firefox extensions, etc.

That's fine.

I didn't reference those examples because I assume Gloo is "like React or jQuery", I mentioned them because their introductions are relatively pointed and explicit.

@HiruNya
Copy link

HiruNya commented May 7, 2020

When I first went onto this repo, I didn't know what specific functionality it provided either so I'd like to suggest listing all the sub-crates from the crates folder in the readme with a small description of what each sub crate does.

@TheButlah
Copy link

TheButlah commented Sep 13, 2020

Hi, random github user perusing WASM crates here. Putting something similar to @Pauan's comment in the README and enumerating the various sub-crates/modules would be helpful to quickly grok what the library does. If gloo is a toolkit, something should enumerate the tools.

@jquesada2016
Copy link

100% agree with @HiruNya. I also didn't know what the crate provided without digging in deeper.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants