docs(v2): style readme, move mapping #679
Conversation
cjquines
commented
May 16, 2024
cjquines
commented
- cuts the readme
- moves mapping to docs site (unlinked from header for now)
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## beta #679 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 147
Lines ? 10161
Branches ? 734
========================================
Hits ? 10161
Misses ? 0
Partials ? 0 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
I think the README is too short. I think a lot of people check out the github and npmjs pages just to see how serious the project is, and having a bunch of links to a docs site without anything else would be a red flag. Looking at all other similar projects they all have build status, a summary of key points, installation instructions, etc...
There was a problem hiding this comment.
Happy to get the README in better shape. My longer term goal is to break down the advantages into 3-4 distinct themes:
- Useful utilities (e.g. partition)
- Amazing types for compile time safety (e.g. map)
- Hybrid dataFirst and dataLast to make any style of code work in any part of the project.
- Implicit Lazy evaluation.
|
|
||
| // Lodash | ||
| _.pick(obj, ["firstName", "lastName"]); | ||
| ```bash |
There was a problem hiding this comment.
Is the hipster thing to also include pnpm and bun?
There was a problem hiding this comment.
i feel like if we were really hipster we would pick only bun and stick with that!
but fair point, i'll add it, it's already in the front page of the docs anyway
| R.filter((x) => x.gender === "f"), | ||
| R.groupBy((x) => x.age), | ||
| ); | ||
| import * as R from "remeda"; |
There was a problem hiding this comment.
Let's also mention that imports could be done by name. I think some people might find this syntax confusing.
import { map } from "remeda";
|
🎉 This PR is included in version 2.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
