docs(readme): Update with accurate API documentation and cover image#10
Merged
docs(readme): Update with accurate API documentation and cover image#10
Conversation
Fixes #9 - Add cover image (docs/assets/cover.png) - Fix connection API: Dynamite.config() → new Dynamite().connect() - Add missing decorators: @DeleteAt, @serialize, @hasone, @manytomany, @column - Add missing methods: attach(), detach(), sync(), forceDestroy(), withTrashed(), onlyTrashed() - Add missing types: InferRelations, CreateInput, UpdateInput - Fix query operators: begins-with → $include - Remove incorrect HasMany<T>/BelongsTo<T> types (they're decorators) - Reduce from 1,272 to 461 lines
arcaela
added a commit
that referenced
this pull request
Dec 13, 2025
…10) Fixes #9 - Add cover image (docs/assets/cover.png) - Fix connection API: Dynamite.config() → new Dynamite().connect() - Add missing decorators: @DeleteAt, @serialize, @hasone, @manytomany, @column - Add missing methods: attach(), detach(), sync(), forceDestroy(), withTrashed(), onlyTrashed() - Add missing types: InferRelations, CreateInput, UpdateInput - Fix query operators: begins-with → $include - Remove incorrect HasMany<T>/BelongsTo<T> types (they're decorators) - Reduce from 1,272 to 461 lines
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #9
Complete README rewrite with accurate information from the actual codebase.
Changes
docs/assets/cover.pngDynamite.config()new Dynamite().connect()Added
@DeleteAt,@Serialize,@HasOne,@ManyToMany,@Columnattach(),detach(),sync(),forceDestroy(),withTrashed(),onlyTrashed()InferRelations,CreateInput,UpdateInputdynamite.tx()documentationFixed
$includeinstead ofbegins-withHasMany<T>/BelongsTo<T>types (they're decorators)Removed
Test plan