Skip to content

Clarify this is for Android only #1

New issue

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

#

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

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify this is for Android only #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Snippet

> Snippet is a small extensible library to measure execution times of the code sections
> in a way that does not compromise with the readability and can be shipped to production
> without any additional setup.
Snippet is a small extensible Android library to measure execution times of the code sections
in a way that does not compromise with the readability and can be shipped to production
without any additional setup.

> New behaviors can be added in the library by extending
> MeasuredExecutionPath - The code path the does the measurement code spans
> ReleaseExecutionPath - A no-op path (default path) that is usually installed in the release variants.
New behaviors can be added in the library by extending

- MeasuredExecutionPath - The code path the does the measurement code spans
- ReleaseExecutionPath - A no-op path (default path) that is usually installed in the release variants.

# Features
1. Easy to integrate and configure
Expand All @@ -20,6 +21,7 @@
9. Fully documented, just run java docs! Working on a hosted documentation.

# Vocabulary

1. Capture: Logical span of code. Can be contiguous or non-contiguous
2. Splits: Sections of code in b/w a capture, measures the delta from last split.
3. LogToken: Tracks noncontiguous captures.
Expand Down