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

Error in @promster/metrics doc? #15

Closed
katmatt opened this issue Aug 24, 2018 · 2 comments
Closed

Error in @promster/metrics doc? #15

katmatt opened this issue Aug 24, 2018 · 2 comments

Comments

@katmatt
Copy link

katmatt commented Aug 24, 2018

After reading the section https://github.com/tdeekens/promster#promstermetrics of the readme.md I'm a little bit confused: The section is called @promster/metrics, but in the example snippet you do:

const { getSummary, getContentType } = require('@promster/express');

I've seen that @promster/express and @promster/hapi export these functions too. But why do I then have to use/install @promster/metrics at all?

@katmatt katmatt changed the title Error in @promster/metrics doc Error in @promster/metrics doc? Aug 24, 2018
@tdeekens
Copy link
Owner

Nice catch. Sorry about the confusion. It's correct to import from @promster/express. It under the hood provides things from @promster/metrics but you:

  1. Don't have to know nor care
  2. Versions can't get out of sync of both packages

You don't have to install @promster/metrics at all. I will fix that in the docs.

@katmatt
Copy link
Author

katmatt commented Aug 27, 2018

Thanks a lot 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants