Skip to content

Commit

Permalink
chore: tidy text and improve branding (#1292)
Browse files Browse the repository at this point in the history
Signed-off-by: tison <[email protected]>
  • Loading branch information
tisonkun authored Jan 3, 2024
1 parent 53b166b commit fd7ef37
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 24 deletions.
24 changes: 24 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
11 changes: 6 additions & 5 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -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.
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.
2 changes: 1 addition & 1 deletion java/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fury Java
# Apache Fury Java

## Code format

Expand Down
4 changes: 2 additions & 2 deletions javascript/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
./package-lock.json
coverage
package-lock.json
coverage
2 changes: 1 addition & 1 deletion javascript/.npmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
package-lock=false
package-lock=false
22 changes: 14 additions & 8 deletions javascript/README.md
Original file line number Diff line number Diff line change
@@ -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';

Expand All @@ -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.
5 changes: 3 additions & 2 deletions licenserc.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion python/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Fury Python
# Apache Fury Python
2 changes: 1 addition & 1 deletion rust/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion scala/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fury Scala
# Apache Fury Scala

Fury supports all scala object serialization:
- `case` class serialization supported
Expand Down
5 changes: 3 additions & 2 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Fury C++
# Apache Fury C++

## How to build

```bash
bazel build //:all
bazel test //:all
```
```

0 comments on commit fd7ef37

Please sign in to comment.