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

Improves readme. #10

Merged
merged 6 commits into from
Mar 23, 2018
Merged

Improves readme. #10

merged 6 commits into from
Mar 23, 2018

Conversation

jcchavezs
Copy link
Contributor

No description provided.


### Run tests
- PHP 5.6 or later
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Miss bcmath extension. I know this is still wip but that way I don't forget :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@@ -18,7 +18,6 @@
"minimum-stability": "dev",
"require": {
"php": "^5.6||^7.0",
"ext-bcmath": "*",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinlebrun removed the dependency.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@jcchavezs jcchavezs changed the title [WIP] Improves readme. Improves readme. Mar 21, 2018
@palazzem palazzem added ☠️ do-not-merge/WIP 🍏 core Changes to the core tracing functionality labels Mar 22, 2018
@palazzem palazzem added this to the 0.1.0 milestone Mar 22, 2018
@palazzem palazzem added cat:docs and removed 🍏 core Changes to the core tracing functionality ☠️ do-not-merge/WIP labels Mar 22, 2018
README.md Outdated
'global_tags' => ['host' => 'hostname'],
];

$tracer = new Tracer($transport, [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

general design: can't we provide reasonable defaults to avoid all this configuration? it's quite long to configure the tracer. If it already has defaults, let's create an advanced section with this snippet and a simple "Getting Started" where you initialize the tracer with defaults + trace a code-block

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tracer comes with all this defaults, the reason why I included it in the example was to show all accepted arguments in the config. We can definitively move them to a advanced config or simply add a link in the bottom to the actual code (which also includes information).

/**
* Enabled, when false, returns a no-op implementation of the Tracer.
*/
'enabled' => true,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this as it was not being used and can not find how is it being used in other libraries. cc @palazzem

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

Successfully merging this pull request may close these issues.

3 participants