From 3bca38e82501b78b03485fb7c14b60f499bd2bc8 Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:14:53 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..f7f769f --- /dev/null +++ b/README.en.md @@ -0,0 +1,103 @@ +

DiceBear Avatar Library

+ +DiceBear is an open source avatar library. It turns any seed string (a username +or an email address, for example) into an SVG avatar in one of 35+ styles +designed by various artists. The same seed always produces the same avatar, so +you store a string instead of an image and never ask users to upload a profile +picture. + +Avatars are customizable through style options: colors, backgrounds, rotation, +individual features like hair or glasses. + +[Playground](https://www.dicebear.com/playground) | +[Documentation](https://www.dicebear.com/introduction) | +[Editor](https://editor.dicebear.com) + +## One library, six languages + +DiceBear 10 ships as native libraries for JavaScript, PHP, Python, Rust, Go, and +Dart. Every port passes a shared test suite that requires byte-identical SVG +output to the JavaScript reference. Generate an avatar in the browser, +regenerate it later in a Go or PHP backend, and you get the same bytes. + +| Language | Package | Install | +| ----------------------- | ----------------------------------------------------------------------- | -------------------------------------------- | +| JavaScript / TypeScript | [`@dicebear/core`](https://www.npmjs.com/package/@dicebear/core) | `npm install @dicebear/core` | +| PHP | [`dicebear/core`](https://packagist.org/packages/dicebear/core) | `composer require dicebear/core` | +| Python | [`dicebear-core`](https://pypi.org/project/dicebear-core/) | `pip install dicebear-core` | +| Rust | [`dicebear-core`](https://crates.io/crates/dicebear-core) | `cargo add dicebear-core` | +| Go | [`dicebear-go`](https://pkg.go.dev/github.com/dicebear/dicebear-go/v10) | `go get github.com/dicebear/dicebear-go/v10` | +| Dart | [`dicebear_core`](https://pub.dev/packages/dicebear_core) | `dart pub add dicebear_core` | + +In JavaScript it looks like this; the +[documentation](https://www.dicebear.com/introduction) has the equivalent for +each language: + +```js +import { Avatar } from '@dicebear/core'; +import definition from '@dicebear/styles/lorelei.json' with { type: 'json' }; + +const avatar = new Avatar(definition, { + seed: 'John Doe', + size: 128, +}); + +avatar.toString(); // SVG string +avatar.toDataUri(); // data:image/svg+xml;charset=utf-8,... +``` + +The 35+ avatar styles are plain JSON definitions from the +[`dicebear/styles`](https://github.com/dicebear/styles) repository, available as +a package for each language. You can also +[create your own style](https://www.dicebear.com/guides/create-an-avatar-style-with-figma/), +with Figma or from scratch. + +## Without writing code + +- The [HTTP API](https://www.dicebear.com/how-to-use/http-api/) returns avatars + from a plain URL, free and without an account: + `https://api.dicebear.com/10.x/lorelei/svg?seed=Felix`. For full control and + privacy you can + [host it yourself](https://www.dicebear.com/guides/host-the-http-api-yourself/) + with a single Docker container. +- The [CLI](https://www.dicebear.com/how-to-use/cli/) generates avatar files in + bulk: `npx dicebear lorelei --count 10`. +- The [editor](https://editor.dicebear.com) lets you assemble a single avatar by + hand and export it. + +## This repository + +This monorepo contains the six core libraries, the CLI, the SVG-to-raster +converter, the documentation site ([dicebear.com](https://www.dicebear.com)), +and the editor. Related projects live in their own repositories: + +- [`dicebear/styles`](https://github.com/dicebear/styles): the official avatar + style definitions +- [`dicebear/schema`](https://github.com/dicebear/schema): the JSON Schema + behind definitions and options +- [`dicebear/api`](https://github.com/dicebear/api): the self-hostable HTTP API +- [`dicebear/exporter-plugin-for-figma`](https://github.com/dicebear/exporter-plugin-for-figma): + the Figma plugin for style authors + +Contributions are welcome; [CONTRIBUTING.md](./CONTRIBUTING.md) explains the +setup and where each kind of change belongs. + +## License + +The code is [MIT licensed](./LICENSE), including commercial use. The avatar +styles are the work of their respective artists and carry their own licenses; +the [license overview](https://www.dicebear.com/licenses/) lists them all, and +many only ask for attribution. + +## Sponsors + +Advertisement: Many thanks to our sponsors who provide us with free or +discounted products. + + + + + + bunny.net + +