This is an automated email from the ASF dual-hosted git repository.
chaokunyang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fury.git
The following commit(s) were added to refs/heads/main by this push:
new 4c119025 chore: keep fury for maven artifact (#2264)
4c119025 is described below
commit 4c1190255ea63a30f542976cdb9a266da86ab28a
Author: Shawn Yang <[email protected]>
AuthorDate: Thu May 29 13:56:31 2025 +0800
chore: keep fury for maven artifact (#2264)
<!--
**Thanks for contributing to Fory.**
**If this is your first time opening a PR on fory, you can refer to
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).**
Contribution Checklist
- The **Apache Fory (incubating)** community has restrictions on the
naming of pr titles. You can also find instructions in
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
- Fory has a strong focus on performance. If the PR you submit will have
an impact on performance, please benchmark it first and provide the
benchmark result here.
-->
## What does this PR do?
#2263
## Does this PR introduce any user-facing change?
<!--
If any user-facing interface changes, please [open an
issue](https://github.com/apache/fory/issues/new/choose) describing the
need to do so and update the document if necessary.
-->
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
## Benchmark
<!--
When the PR has an impact on performance (if you don't know whether the
PR will have an impact on performance, you can submit the PR first, and
if it will have impact on performance, the code reviewer will explain
it), be sure to attach a benchmark data here.
-->
---
README.md | 46 ++++++++++++++++++++++++----------------------
1 file changed, 24 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
index c0adcb5a..33db5b0c 100644
--- a/README.md
+++ b/README.md
@@ -2,20 +2,22 @@
<img width="65%" alt="" src="docs/images/logo/fory_github_banner.png"><br>
</div>
-[](https://github.com/apache/fory/actions/workflows/ci.yml)
-[](https://join.slack.com/t/fory-project/shared_invite/zt-1u8soj4qc-ieYEu7ciHOqA2mo47llS8A)
+[](https://github.com/apache/fury/actions/workflows/ci.yml)
+[](https://join.slack.com/t/fury-project/shared_invite/zt-1u8soj4qc-ieYEu7ciHOqA2mo47llS8A)
[](https://x.com/ApacheFory)
-[](https://search.maven.org/#search|gav|1|g:"org.apache.fory"%20AND%20a:"fory-core")
+[](https://search.maven.org/#search|gav|1|g:"org.apache.fury"%20AND%20a:"fury-core")
**Apache Fory (incubating)** is a blazingly-fast multi-language serialization
framework powered by **JIT** (just-in-time compilation) and **zero-copy**,
providing up to 170x performance and ultimate ease of use.
-<https://fory.apache.org>
+<https://fury.apache.org>
> [!IMPORTANT]
> Apache Fory (incubating) is an effort undergoing incubation at the Apache
> Software Foundation (ASF), sponsored by the Apache Incubator PMC.
>
> Please read the [DISCLAIMER](DISCLAIMER) and a full explanation of
> ["incubating"](https://incubator.apache.org/policy/incubation.html).
+>
+> Apache Fory was previously named as Apache Fury. For versions less than
0.11, please use "fury" instead of "fory" in package names, imports, and
dependencies.
## Features
@@ -107,14 +109,14 @@ Nightly snapshot:
</repository>
</repositories>
<dependency>
- <groupId>org.apache.fory</groupId>
- <artifactId>fory-core</artifactId>
+ <groupId>org.apache.fury</groupId>
+ <artifactId>fury-core</artifactId>
<version>0.11.0-SNAPSHOT</version>
</dependency>
<!-- row/arrow format support -->
<!-- <dependency>
- <groupId>org.apache.fory</groupId>
- <artifactId>fory-format</artifactId>
+ <groupId>org.apache.fury</groupId>x
+ <artifactId>fury-format</artifactId>
<version>0.11.0-SNAPSHOT</version>
</dependency> -->
```
@@ -123,14 +125,14 @@ Release version:
```xml
<dependency>
- <groupId>org.apache.fory</groupId>
- <artifactId>fory-core</artifactId>
+ <groupId>org.apache.fury</groupId>
+ <artifactId>fury-core</artifactId>
<version>0.10.3</version>
</dependency>
<!-- row/arrow format support -->
<!-- <dependency>
- <groupId>org.apache.fory</groupId>
- <artifactId>fory-format</artifactId>
+ <groupId>org.apache.fury</groupId>
+ <artifactId>fury-format</artifactId>
<version>0.10.3</version>
</dependency> -->
```
@@ -140,21 +142,21 @@ Release version:
Scala2:
```sbt
-libraryDependencies += "org.apache.fory" % "fory-scala_2.13" % "0.10.3"
+libraryDependencies += "org.apache.fury" % "fury-scala_2.13" % "0.10.3"
```
Scala3:
```sbt
-libraryDependencies += "org.apache.fory" % "fory-scala_3" % "0.10.3"
+libraryDependencies += "org.apache.fury" % "fury-scala_3" % "0.10.3"
```
### Kotlin
```xml
<dependency>
- <groupId>org.apache.fory</groupId>
- <artifactId>fory-kotlin</artifactId>
+ <groupId>org.apache.fury</groupId>
+ <artifactId>fury-kotlin</artifactId>
<version>0.10.3</version>
</dependency>
```
@@ -187,8 +189,8 @@ If you don't have cross-language requirements, using this
mode will
result in better performance.
```java
-import org.apache.fory.*;
-import org.apache.fory.config.*;
+import org.apache.fury.*;
+import org.apache.fury.config.*;
import java.util.*;
public class Example {
@@ -235,8 +237,8 @@ public class Example {
**Java**
```java
-import org.apache.fory.*;
-import org.apache.fory.config.*;
+import org.apache.fury.*;
+import org.apache.fury.config.*;
import java.util.*;
public class ReferenceExample {
@@ -254,7 +256,7 @@ public class ReferenceExample {
return obj;
}
- // mvn exec:java -Dexec.mainClass="org.apache.fory.examples.ReferenceExample"
+ // mvn exec:java -Dexec.mainClass="org.apache.fury.examples.ReferenceExample"
public static void main(String[] args) {
Fory fory = Fory.builder().withLanguage(Language.XLANG)
.withRefTracking(true).build();
@@ -417,7 +419,7 @@ For example, the deserialization may invoke `init`
constructor or `equals`/`hash
Fory provides a class registration option that is enabled by default for such
protocols, allowing only deserialization of trusted registered types or
built-in types.
**Do not disable class registration unless you can ensure your environment is
secure**.
-If this option is disabled, you are responsible for serialization security.
You can configure `org.apache.fory.resolver.ClassChecker` by
+If this option is disabled, you are responsible for serialization security.
You can configure `org.apache.fury.resolver.ClassChecker` by
`ClassResolver#setClassChecker` to control which classes are allowed for
serialization.
To report security vulnerabilities found in Fory, please follow the [ASF
vulnerability reporting
process](https://apache.org/security/#reporting-a-vulnerability).
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
