This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-fury.git
The following commit(s) were added to refs/heads/main by this push:
new fd7ef373 chore: tidy text and improve branding (#1292)
fd7ef373 is described below
commit fd7ef37325f1ab801852a633d2d4dcb8f3808e31
Author: tison <[email protected]>
AuthorDate: Wed Jan 3 11:00:23 2024 +0800
chore: tidy text and improve branding (#1292)
Signed-off-by: tison <[email protected]>
---
.editorconfig | 24 ++++++++++++++++++++++++
go/README.md | 11 ++++++-----
java/README.md | 2 +-
javascript/.gitignore | 4 ++--
javascript/.npmrc | 2 +-
javascript/README.md | 22 ++++++++++++++--------
licenserc.toml | 5 +++--
python/README.md | 2 +-
rust/README.md | 2 +-
scala/README.md | 2 +-
src/README.md | 5 +++--
11 files changed, 57 insertions(+), 24 deletions(-)
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 00000000..a8291d1c
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+root = true
+
+[*]
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
diff --git a/go/README.md b/go/README.md
index be7ec4e2..8b4f0104 100644
--- a/go/README.md
+++ b/go/README.md
@@ -1,6 +1,7 @@
-# Fury Go
-Fury is a blazing fast multi-language serialization framework powered by
jit(just-in-time compilation) and zero-copy.
+# Apache Fury™ Go
-Currently fury go are implemented using reflection. In future we plan to
implement a static code generator
-to generate serializer code ahead to speed up serialization, or implement a
jit framework which generate asm instructions
-to speed up serialization.
\ No newline at end of file
+Fury is a blazing fast multi-language serialization framework powered by
just-in-time compilation and zero-copy.
+
+Currently, Fury Go is implemented using reflection. In the future, we plan to
implement a static code generator
+to generate serializer code ahead to speed up serialization, or implement a
JIT framework which generate ASM
+instructions to speed up serialization.
diff --git a/java/README.md b/java/README.md
index a7e7a64c..578f43d5 100644
--- a/java/README.md
+++ b/java/README.md
@@ -1,4 +1,4 @@
-# Fury Java
+# Apache Fury™ Java
## Code format
diff --git a/javascript/.gitignore b/javascript/.gitignore
index c7e357e9..8216c380 100644
--- a/javascript/.gitignore
+++ b/javascript/.gitignore
@@ -1,2 +1,2 @@
-./package-lock.json
-coverage
\ No newline at end of file
+package-lock.json
+coverage
diff --git a/javascript/.npmrc b/javascript/.npmrc
index 9cf94950..43c97e71 100644
--- a/javascript/.npmrc
+++ b/javascript/.npmrc
@@ -1 +1 @@
-package-lock=false
\ No newline at end of file
+package-lock=false
diff --git a/javascript/README.md b/javascript/README.md
index caec1e51..377da0ea 100644
--- a/javascript/README.md
+++ b/javascript/README.md
@@ -1,14 +1,18 @@
-# Fury JavaScript
-Javascript implementation for the fury protocol.
-The CrossLanguage part of the protocol is not stable, so the output of this
library may change in the future. Please be cautious when using it in a
production environment.
+# Apache Fury™ JavaScript
+
+Javascript implementation for the Fury protocol.
+
+The Cross-Language part of the protocol is not stable, so the output of this
library may change in the future. Please be cautious when using it in a
production environment.
## Install
+
```shell
npm install @furyjs/fury
npm install @furyjs/hps
```
## Usage
+
```Javascript
import Fury, { Type, InternalSerializerType } from '@furyjs/fury';
@@ -33,11 +37,13 @@ console.log(result);
## Packages
### fury
-Implement the protocol of fury, generate javascript code at runtime to make
sure that all the code could be jit by v8 efficiently
+
+Fury protocol implementation. It generates JavaScript code at runtime to make
sure that all the code could be optimized by v8 JIT efficiently.
### hps
-Nodejs high-performance suite, ensuring that your Node.js version is 20 or
later.
-hps is use for detect the string type in v8. Fury support latin1 and utf8
string both, we should get the certain type of string before write it
-in buffer. It is slow to detect the string is latin1 or utf8, but hps can
detect it by a hack way, which is called FASTCALL in v8.
-so it is not stable now.
+Node.js high-performance suite, ensuring that your Node.js version is 20 or
later.
+
+`hps` is use for detect the string type in v8. Fury support latin1 and utf8
string both, we should get the certain type of string before write it
+in buffer. It is slow to detect the string is latin1 or utf8, but hps can
detect it by a hack way, which is called FASTCALL in v8.
+so it is not stable now.
diff --git a/licenserc.toml b/licenserc.toml
index e68540f9..9fe1a849 100644
--- a/licenserc.toml
+++ b/licenserc.toml
@@ -18,11 +18,13 @@
headerPath = "Apache-2.0-ASF.txt"
excludes = [
+ # Skipped
"*.txt",
+ "go.sum",
# Generated
"integration_tests/perftests/src/main/java/org/apache/fury/integration_tests/state/generated/**",
-
+
# Derived
"ci/format.sh",
"java/fury-benchmark/src/main/java/org/apache/fury/benchmark/Identity2IdMap.java",
@@ -50,7 +52,6 @@ excludes = [
"javascript/packages/hps/src/v8-fast-api-calls.h",
"javascript/packages/fury/lib/murmurHash3.ts",
"src/fury/thirdparty/MurmurHash3.*",
- "go/fury/go.sum",
]
[mapping.DOUBLESLASH_STYLE]
diff --git a/python/README.md b/python/README.md
index 7ce59f28..5bd731e5 100644
--- a/python/README.md
+++ b/python/README.md
@@ -1 +1 @@
-# Fury Python
+# Apache Fury™ Python
diff --git a/rust/README.md b/rust/README.md
index 8be5d367..29c26091 100644
--- a/rust/README.md
+++ b/rust/README.md
@@ -1,4 +1,4 @@
-# [Fury](https://github.com/apache/incubator-fury) for Rust
+# Apache Fury™ Rust
Fury is a blazing fast multi-language serialization framework powered by
just-in-time compilation and zero-copy.
diff --git a/scala/README.md b/scala/README.md
index bd324bc0..3691639b 100644
--- a/scala/README.md
+++ b/scala/README.md
@@ -1,4 +1,4 @@
-# Fury Scala
+# Apache Fury™ Scala
Fury supports all scala object serialization:
- `case` class serialization supported
diff --git a/src/README.md b/src/README.md
index c50aae3e..089f2159 100644
--- a/src/README.md
+++ b/src/README.md
@@ -1,7 +1,8 @@
-# Fury C++
+# Apache Fury™ C++
## How to build
+
```bash
bazel build //:all
bazel test //:all
-```
\ No newline at end of file
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
