docs(v2): style readme, move mapping

.github/pull_request_template.md

@@ -7,7 +7,7 @@ Make sure that you:
 - [ ] Typedoc added for new methods and updated for changed
 - [ ] Tests added for new methods and updated for changed
 - [ ] New methods added to `src/index.ts`
-- [ ] New methods added to `mapping.md`
+- [ ] New methods added to `docs/src/pages/mapping.md`
 
 ---
 

README.md

@@ -2,138 +2,10 @@
 
 The first "data-first" and "data-last" utility library designed especially for TypeScript.
 
-![GitHub CI](https://img.shields.io/github/actions/workflow/status/remeda/remeda/ci.yml?branch=beta&label=github-ci)
-[![Codecov](https://img.shields.io/codecov/c/github/remeda/remeda/beta)](https://codecov.io/gh/remeda/remeda)
-[![NPM](https://img.shields.io/npm/v/remeda)](https://www.npmjs.org/package/remeda)
-![Dependencies](https://img.shields.io/librariesio/release/npm/remeda)
+**Introduction & features:** [remedajs.com](https://remedajs.com/)
+<br/>
+**Docs:** [remedajs.com/docs](https://remedajs.com/docs)
 
-## Installation
-
-```bash
-npm i remeda@beta
-yarn add remeda@beta
-```
-
-Then in .js or .ts
-
-```js
-import * as R from "remeda"; // tree-shaking supported!
-```
-
-## Why Remeda?
-
-There are no good utility libraries that work well with TypeScript. When working with Lodash or Ramda you must sometimes annotate types manually.
-Remeda is written and tested in TypeScript and that means there won't be any problems with custom typings.
-
-## What's "data-first" and "data-last"?
-
-Functional programming is nice, and it makes the code more readable. However there are situations where you don't need "pipes", and you want to call just a single function.
-
-```js
-// Remeda
-R.pick(obj, ["firstName", "lastName"]);
-
-// Ramda
-R.pick(["firstName", "lastName"], obj);
-
-// Lodash
-_.pick(obj, ["firstName", "lastName"]);
-```
-
-> For readers looking for data-last forms like `R.filter(fn)(array)`, Remeda supports it. Keep reading along!
-
-In the above example, "data-first" approach is more natural and more programmer friendly because when you type the second argument, you get the auto-complete from IDE. It's not possible to get the auto-complete in Ramda because the data argument is not provided.
-
-"data-last" approach is helpful when writing data transformations aka pipes.
-
-```js
-const users = [
-  { name: "john", age: 20, gender: "m" },
-  { name: "marry", age: 22, gender: "f" },
-  { name: "samara", age: 24, gender: "f" },
-  { name: "paula", age: 24, gender: "f" },
-  { name: "bill", age: 33, gender: "m" },
-];
-
-// Remeda
-R.pipe(
-  users,
-  R.filter((x) => x.gender === "f"),
-  R.groupBy((x) => x.age),
-);
-
-// Ramda
-R.pipe(
-  R.filter((x) => x.gender === "f"),
-  R.groupBy((x) => x.age),
-)(users); // broken typings in TS :(
-
-// Lodash
-_(users)
-  .filter((x) => x.gender === "f")
-  .groupBy((x) => x.age)
-  .value();
-
-// Lodash-fp
-_.flow(
-  _.filter((x) => x.gender === "f"),
-  _.groupBy((x) => x.age),
-)(users); // broken typings in TS :(
-```
-
-Mixing paradigms can be cumbersome in Lodash because it requires importing two different methods.
-Remeda implements all methods in two versions, and the correct overload is picked based on the number of provided arguments.
-The "data-last" version must always have one argument less than the "data-first" version.
-
-```js
-// Remeda
-R.pick(obj, ["firstName", "lastName"]); // data-first
-R.pipe(obj, R.pick(["firstName", "lastName"])); // data-last
-
-R.pick(["firstName", "lastName"], obj); // error, this won't work!
-R.pick(["firstName", "lastName"])(obj); // this will work but the types cannot be inferred
-```
-
-## Lazy evaluation
-
-Many functions support lazy evaluation when using `pipe` or `piped`. These functions have a `pipeable` tag in the documentation.
-Lazy evaluation is not supported in Ramda and only partially supported in lodash.
-
-```js
-// Get first 3 unique values
-const arr = [1, 2, 2, 3, 3, 4, 5, 6];
-
-const result = R.pipe(
-  arr,                    // only four iterations instead of eight (array.length)
-  R.map(x => {
-    console.log('iterate', x);
-    return x;
-  }),
-  R.uniq(),
-  R.take(3)
-); // => [1, 2, 3]
-
-/**
- * Console output:
- * iterate 1
- * iterate 2
- * iterate 2
- * iterate 3
- * /
-
-```
-
-## For Lodash and Ramda users
-
-Please check function mapping in [mapping.md](./mapping.md).
-
-## Remeda Design Goals
-
-1. The usage must be programmer friendly, and that's more important than following XYZ paradigm strictly.
-2. Manual annotation should never be required, and proper typings should infer everything. The only exception is the first function in `piped`.
-3. ES6 polyfill is required. Core methods are reused, and data structure (like Map/Set) are not re-implemented.
-4. The implementation of each function should be as minimal as possible. Tree-shaking is supported by default. (Do you know that `lodash.keyBy` has 14KB after minification?)
-5. All functions are immutable, and there are no side-effects.
-6. Fixed number of arguments.
-
-MIT
+**Migrating from v1:** [remedajs.com/v1](https://remedajs.com/v1)
+<br/>
+**For Lodash and Ramda users:** [remedajs.com/mapping](https://remedajs.com/mapping)

docs/src/layouts/mapping.astro

@@ -0,0 +1,10 @@
+---
+import Prose from "@/components/prose.astro";
+import Layout from "./layout.astro";
+---
+
+<Layout class="flex-1 overflow-y-auto">
+  <main class="container my-6 max-w-5xl">
+    <Prose class="mt-6 max-w-none prose-p:max-w-prose"><slot /></Prose>
+  </main>
+</Layout>