docs: update README for clarity and consistency in English and Japanese

[kazeburo]

PR Type

Documentation

---

Description

• Adds complete English README guidance

• Aligns feature sections bilingually

• Clarifies percentile calculations and behavior

• Replaces embedded MIT text with link

---

Diagram Walkthrough

flowchart LR
  README["README.md"] -- "adds English explanations" --> Bilingual["Bilingual feature and usage sections"]
  README -- "documents API behavior" --> Details["Statistics and percentile details"]
  README -- "simplifies licensing" --> License["MIT License link"]

Loading

File Walkthrough

	Relevant files
Documentation	README.md Expand bilingual README documentation and guidance              README.md Adds English descriptions alongside Japanese documentation. Renames sections with bilingual English/Japanese headings. Clarifies statistics, percentile interpolation, options, and limitations. Replaces embedded MIT license text with a LICENSE link. +53/-61

---

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

Benchmark Comparison

Base: main
PR: feat/readme-en

BenchmarkSampdoAll results

goos: linux
goarch: amd64
pkg: github.com/monitoring-forge/sampdo
cpu: INTEL(R) XEON(R) PLATINUM 8573C
                                        │ base-bench.txt │            pr-bench.txt            │
                                        │     sec/op     │   sec/op     vs base               │
SampdoAll/sampdo/100000/duplicates-4         2.167m ± 1%   2.118m ± 4%  -2.25% (p=0.007 n=10)
SampdoAll/sampdo/100000/random-4             3.133m ± 3%   3.107m ± 2%       ~ (p=0.353 n=10)
SampdoAll/sampdo/100000/wide-4               2.530m ± 2%   2.567m ± 1%  +1.46% (p=0.009 n=10)
SampdoAll/sampdo/100000/sorted-4             211.9µ ± 2%   210.5µ ± 2%       ~ (p=0.912 n=10)
SampdoAll/sampdo/100000/response_time-4      5.141m ± 2%   4.844m ± 6%  -5.79% (p=0.015 n=10)
geomean                                      1.796m        1.767m       -1.64%

                                        │ base-bench.txt │             pr-bench.txt              │
                                        │      B/op      │     B/op      vs base                 │
SampdoAll/sampdo/100000/duplicates-4        1.532Mi ± 0%   1.532Mi ± 0%  -0.00% (p=0.048 n=10)
SampdoAll/sampdo/100000/random-4            1.532Mi ± 0%   1.532Mi ± 0%       ~ (p=0.423 n=10)
SampdoAll/sampdo/100000/wide-4              1.532Mi ± 0%   1.532Mi ± 0%       ~ (p=0.135 n=10)
SampdoAll/sampdo/100000/sorted-4            785.1Ki ± 0%   785.1Ki ± 0%       ~ (p=1.000 n=10) ¹
SampdoAll/sampdo/100000/response_time-4     1.532Mi ± 0%   1.532Mi ± 0%       ~ (p=1.000 n=10)
geomean                                     1.334Mi        1.334Mi       -0.00%
¹ all samples are equal

                                        │ base-bench.txt │            pr-bench.txt             │
                                        │   allocs/op    │ allocs/op   vs base                 │
SampdoAll/sampdo/100000/duplicates-4          5.000 ± 0%   5.000 ± 0%       ~ (p=1.000 n=10) ¹
SampdoAll/sampdo/100000/random-4              5.000 ± 0%   5.000 ± 0%       ~ (p=1.000 n=10) ¹
SampdoAll/sampdo/100000/wide-4                5.000 ± 0%   5.000 ± 0%       ~ (p=1.000 n=10) ¹
SampdoAll/sampdo/100000/sorted-4              4.000 ± 0%   4.000 ± 0%       ~ (p=1.000 n=10) ¹
SampdoAll/sampdo/100000/response_time-4       5.000 ± 0%   5.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean                                       4.782        4.782       +0.00%
¹ all samples are equal

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Contradictory Docs The feature description says slices.Sort is used only when negative or -0 values are present, but the documented WithPreferSlicesSort(true) option also forces slices.Sort for non-negative data. This makes the stated behavior incomplete and can mislead users evaluating sorting performance. - **Radix sort for non-negative numbers / 非負数向け基数ソート**: Falls back to `slices.Sort` only when negative or `-0` values are present. 負数や `-0` がある場合のみ `slices.Sort` にフォールバックします。

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.