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.

Sign up for GitHub

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

refine user document #25

Merged
merged 2 commits into from
Nov 11, 2024
Merged

refine user document #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd5321c
refine document
chaokunyang Nov 10, 2024
f6b21e9
Update docs/modules/ROOT/pages/index.adoc
chaokunyang Nov 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ import jakarta.ws.rs.Path;

import org.apache.fury.BaseFury;

@FurySerialization
record Foo(int f1, String f2, List<String> f3, Map<String, Long> f4) {
}

@Path("/fury")
@ApplicationScoped
public class FuryResources {
@FurySerialization
public record Foo(int f1, String f2, List<String> f3, Map<String, Long> f4) {
}

@Inject
BaseFury fury;

Expand Down
5 changes: 3 additions & 2 deletions docs/modules/ROOT/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

include::./includes/attributes.adoc[]

TIP: Describe what the extension does here.
Integrates with the Apache Fury serialization framework. https://github.com/apache/fury[Apache Fury] is a blazingly fast multi-language serialization framework powered by JIT and zero-copy. With the `quarkus-fury` extension, users can use fast and easy-to-use serialization feature provided by Apache Fury out-of-box.


== Installation

Expand Down Expand Up @@ -83,7 +84,7 @@ If the class is a third-party class which you can't add annotation, you can spec
import io.quarkiverse.fury.FurySerialization;

@FurySerialization(classId = 200, serializer = FooSerializer.class, targetClasses = Foo.class)
record FooConfig(int f1, String f2, List<String> f3, Map<String, Long> f4) {
public class FooConfig {
}
----

Expand Down