From 155d4872c21325ee633179365bff95ffb05907d7 Mon Sep 17 00:00:00 2001 From: Bruno Borges Date: Wed, 24 Nov 2021 14:52:28 -0800 Subject: [PATCH] Clarify this is for Android only --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 41e12d2..6717d23 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.