Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: updated readme #105

Merged
merged 1 commit into from
Mar 26, 2024
Merged

feat: updated readme #105

merged 1 commit into from
Mar 26, 2024

Conversation

samuelOsborne
Copy link
Member

No description provided.

Copy link

changeset-bot bot commented Mar 25, 2024

⚠️ No Changeset found

Latest commit: 000dde0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

README.md Outdated
Comment on lines 15 to 17
<p align="center">
<img src="./assets/design.png" alt="dotLottie architecture"/>
</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can include the mermaid code diagram directly

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@theashraf Added! its really cool

README.md Outdated

- [For your dotLottie creation and modification needs](https://github.com/dotlottie/dotlottie-js)
- [Tools for parsing Lottie animations](https://github.com/LottieFiles/relottie)
- [dotLottie playground for creating multi-animations dotLotties](https://dotlottie.github.io/player-component/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dotLottie playground is currently utilizing the player-component, which may become irrelevant soon as we begin the deprecation process. It's likely necessary to migrate the dotLottie playground/viewer to either the dotlottie-rs or dotlottie-web GitHub pages. This migration should include refactoring it from using the player-component to utilizing dotlottie-web.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

have removed, can add it back when we complete the repo move

@@ -12,21 +12,29 @@

This is the Rust implementation of the dotLottie player and its related tools. It utilizes uniffi-rs to generate FFI bindings for Kotlin, Swift, and WebAssembly (WASM). these bindings are then used in the native dotLottie players for [Android](https://github.com/LottieFiles/dotlottie-android), [iOS](https://github.com/LottieFiles/dotlottie-ios), and [Web](https://github.com/LottieFiles/dotlottie-web) bringing consistency of playback and dotLottie features across all platforms.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include:

  • The problem dotlottie-rs solves (fragmentation and rendering inconsistency issues)
  • The features it supports

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added @theashraf please review

@@ -1,6 +1,6 @@
# dotLottie Rust

![CI](https://github.com/LottieFiles/dotlottie-rs/workflows/release/badge.svg)
![CI](https://img.shields.io/github/v/release/LottieFiles/dotlottie-rs)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!!

@samuelOsborne samuelOsborne merged commit 9b2f1a3 into main Mar 26, 2024
1 check passed
@samuelOsborne samuelOsborne deleted the feat/readme-updates branch March 26, 2024 11:51
@github-actions github-actions bot mentioned this pull request Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants