Skip to content

Commit 6d150a8

Browse files
psxjoypsxjoy
authored
Merge branch 'main' into fesod-contributing
2 parents c74778e + 9480724 commit 6d150a8

File tree

3 files changed

+79
-395
lines changed

3 files changed

+79
-395
lines changed

‎README.md‎

Lines changed: 79 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,71 @@
1-
<p align="center">
2-
<img src="logo.svg"/>
3-
</p>
4-
5-
<p align="center">
6-
<a href="README.md">English</a> | <a href="README_ZH.md">中文</a> | <a href="README_JP.md">日本語</a>
7-
</p>
8-
9-
<p align="center">
10-
<a href="https://github.com/fast-excel/fastexcel/actions/workflows/ci.yml"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/fast-excel/fastexcel/ci.yml?style=flat-square&logo=github"></a>
11-
<a href="https://github.com/fast-excel/fastexcel/actions/workflows/nightly.yml"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/fast-excel/fastexcel/nightly.yml?style=flat-square&logo=github&label=nightly"></a>
12-
<a href="https://github.com/fast-excel/fastexcel/blob/main/LICENSE"><img alt="GitHub License" src="https://img.shields.io/github/license/fast-excel/fastexcel?logo=apache&style=flat-square"></a>
13-
<a href="https://mvnrepository.com/artifact/cn.idev.excel/fastexcel"><img alt="Maven Central Version" src="https://img.shields.io/maven-central/v/cn.idev.excel/fastexcel?logo=apachemaven&style=flat-square"></a>
14-
</p>
15-
16-
<p align="center">
17-
<a href="https://fast-excel.github.io/fastexcel/"><img alt="Document" src="https://img.shields.io/github/actions/workflow/status/fast-excel/fastexcel/ci.yml?style=flat-square&logo=read-the-docs&label=Document"></a>
18-
<a href="https://deepwiki.com/fast-excel/fastexcel"><img src="https://img.shields.io/badge/DeepWiki-fast--excel%2Ffastexcel-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==" alt="DeepWiki"></a>
19-
<a href="https://readmex.com/fast-excel/fastexcel"><img src="https://raw.githubusercontent.com/CodePhiliaX/resource-trusteeship/main/readmex.svg" alt="ReadmeX"></a>
20-
</p>
21-
22-
## What is FastExcel
23-
24-
Fast, Concise, Java tool for processing Excel files that solves memory overflow issues with large files.
25-
26-
FastExcel will always be free and open source, use the business-friendly Apache license, making it suitable for any
27-
commercial scenarios. This provides developers and enterprises with great freedom and flexibility.
28-
We plan to introduce more new features in the future to continually enhance user experience and tool usability. Stay
29-
tuned to "Programmer Xiao Lan's" public account for updates on the development of FastExcel. FastExcel is committed to
30-
being your best choice for handling Excel files.
31-
32-
## Features
33-
34-
- **High-performance Reading and Writing**: FastExcel focuses on performance optimization, capable of efficiently
35-
handling large-scale Excel data. Compared to some traditional Excel processing libraries, it can significantly reduce
36-
memory consumption.
1+
<!--
2+
- Licensed to the Apache Software Foundation (ASF) under one or more
3+
- contributor license agreements. See the NOTICE file distributed with
4+
- this work for additional information regarding copyright ownership.
5+
- The ASF licenses this file to You under the Apache License, Version 2.0
6+
- (the "License"); you may not use this file except in compliance with
7+
- the License. You may obtain a copy of the License at
8+
-
9+
- http://www.apache.org/licenses/LICENSE-2.0
10+
-
11+
- Unless required by applicable law or agreed to in writing, software
12+
- distributed under the License is distributed on an "AS IS" BASIS,
13+
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
- See the License for the specific language governing permissions and
15+
- limitations under the License.
16+
-->
17+
18+
# Apache Fesod (Incubating)
19+
20+
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/apache/fesod/ci.yml?style=flat-square&logo=github)](https://github.com/apache/fesod/actions/workflows/ci.yml)
21+
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/apache/fesod/nightly.yml?style=flat-square&logo=github&label=nightly)](https://github.com/apache/fesod/actions/workflows/nightly.yml)
22+
[![GitHub License](https://img.shields.io/github/license/apache/fesod?logo=apache&style=flat-square)](https://github.com/apache/fesod/blob/main/LICENSE)
23+
![Maven Central Version](https://img.shields.io/maven-central/v/org.apache.fesod/fesod?logo=apachemaven&style=flat-square)
24+
[![Document](https://img.shields.io/github/actions/workflow/status/apache/fesod/ci.yml?style=flat-square&logo=read-the-docs&label=Document)](https://fesod.apache.org/)
25+
[![DeepWiki](https://img.shields.io/badge/DeepWiki-apache%2Ffesod-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/apache/fesod)
26+
27+
## Introduction
28+
29+
**Apache Fesod (Incubating)** is a high-performance and memory-efficient Java library for reading and writing Excel
30+
files, designed to simplify development and ensure reliability.
31+
32+
Apache Fesod (Incubating) can provide developers and enterprises with great freedom and flexibility. We plan to
33+
introduce more new features in the future to continually enhance user experience and tool usability. Apache Fesod (
34+
Incubating) is committed to being your best choice for handling Excel files.
35+
36+
The name fesod(pronounced `/ˈfɛsɒd/`), an acronym for "fast easy spreadsheet and other documents" expresses the
37+
project's origin, background and vision.
38+
39+
### Features
40+
41+
- **High-performance Reading and Writing**: Apache Fesod (Incubating) focuses on performance optimization, capable of
42+
efficiently handling large-scale Excel data. Compared to some traditional Excel processing libraries, it can
43+
significantly reduce memory consumption.
3744
- **Simplicity and Ease of Use**: The library offers a simple and intuitive API, allowing developers to easily integrate
3845
it into projects, whether for simple Excel operations or complex data processing.
39-
- **Stream Operations**: FastExcel supports stream reading, minimizing the problem of loading large amounts of data at
40-
once. This design is especially important when dealing with hundreds of thousands or even millions of rows of data.
46+
- **Stream Operations**: Apache Fesod (Incubating) supports stream reading, minimizing the problem of loading large
47+
amounts of data at once. This design is especially important when dealing with hundreds of thousands or even millions
48+
of rows of data.
4149

4250
## Installation
4351

44-
The following table lists the minimum Java language version requirements for each version of the FastExcel library:
52+
Apache Fesod (Incubating) requires **Java 1.8** or later. Using the latest LTS release of Java is encouraged. We
53+
strongly recommend using the latest version of Apache Fesod (Incubating), as performance optimizations, bug fixes, and
54+
new features in the latest version will enhance your experience.
4555

46-
| Version | JDK Version Support Range | Notes |
47-
|----------|:-------------------------:|-------|
48-
| 1.3.x | JDK8 - JDK25 | |
49-
| 1.2.x | JDK8 - JDK21 | |
50-
| 1.1.x | JDK8 - JDK21 | |
51-
| 1.0.x | JDK8 - JDK21 | |
52-
53-
We strongly recommend using the latest version of FastExcel, as performance optimizations, bug fixes, and new features
54-
in the latest version will enhance your experience.
55-
56-
> Currently, FastExcel uses POI as its underlying package. If your project already includes POI-related components, you
56+
> Currently, Apache Fesod (Incubating) uses POI as its underlying package. If your project already includes POI-related
57+
> components, you
5758
> will need to manually exclude POI-related jar files.
5859
59-
### Version Update
60-
61-
For detailed update logs, refer to [Details of version updates](./CHANGELOG.md). You can also find all available
62-
versions in the [Maven Central Repository](https://mvnrepository.com/artifact/cn.idev.excel/fastexcel).
63-
6460
### Maven
6561

6662
If you are using Maven for project building, add the following configuration in the `pom.xml` file:
6763

6864
```xml
6965

7066
<dependency>
71-
<groupId>cn.idev.excel</groupId>
72-
<artifactId>fastexcel</artifactId>
67+
<groupId>org.apache.fesod</groupId>
68+
<artifactId>fesod</artifactId>
7369
<version>version</version>
7470
</dependency>
7571
```
@@ -80,13 +76,13 @@ If you are using Gradle for project building, add the following configuration in
8076

8177
```gradle
8278
dependencies {
83-
implementation 'cn.idev.excel:fastexcel:version'
79+
implementation 'org.apache.fesod:fesod:version'
8480
}
8581
```
8682

87-
## Example
83+
## QuickStart
8884

89-
### Reading Excel Files
85+
### Read
9086

9187
Below is an example of reading an Excel document:
9288

@@ -108,11 +104,11 @@ public class DemoDataListener implements ReadListener<DemoData> {
108104
public static void main(String[] args) {
109105
String fileName = "demo.xlsx";
110106
// Read Excel file
111-
FastExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
107+
Fesod.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
112108
}
113109
```
114110

115-
### Creating Excel Files
111+
### Write
116112

117113
Below is a simple example of creating an Excel document:
118114

@@ -149,28 +145,38 @@ private static List<DemoData> data() {
149145
public static void main(String[] args) {
150146
String fileName = "demo.xlsx";
151147
// Create a "Template" sheet and write data
152-
FastExcel.write(fileName, DemoData.class).sheet("Template").doWrite(data());
148+
Fesod.write(fileName, DemoData.class).sheet("Template").doWrite(data());
153149
}
154150
```
155151

156-
## Contributing
152+
## Community
153+
154+
### Contributors
157155

158-
Contributors are welcomed to join the FastExcel project. Please check [Contributing Guide](./CONTRIBUTING.md) about how
159-
to contribute to this project.
156+
Contributors are welcomed to join the Apache Fesod (Incubating). Please
157+
check [Contributing Guide](https://fesod.apache.org/community/contribution/) about how to contribute to this project.
160158

161-
Thank you to all the people who already contributed to FastExcel!
159+
Thank you to all the people who already contributed to the Apache Fesod (Incubating) !
162160

163-
<a href="https://github.com/fast-excel/fastexcel/graphs/contributors">
164-
<img src="https://contrib.rocks/image?repo=fast-excel/fastexcel"/>
161+
<a href="https://github.com/apache/fesod/graphs/contributors">
162+
<img src="https://contrib.rocks/image?repo=apache/fesod"/>
165163
</a>
166164

167165
> Note: Showing the first 100 contributors only due to GitHub image size limitations
168166
169-
## Star History
167+
### Subscribe Mailing Lists
170168

171-
[![Star History Chart](https://api.star-history.com/svg?repos=fast-excel/fastexcel&type=Date)](https://www.star-history.com/#fast-excel/fastexcel&Date)
169+
Mail List is the most recognized form of communication in the Apache community. Contact us through the following mailing
170+
list.
172171

173-
## License
172+
| Name | Mailing list |
173+
|:----------------------------------------------------|:--------------------------------------------------------------------------------------------------------------|
174+
| [[email protected]](mailto:[email protected]) | [Subscribe](mailto:[email protected]) ｜ [Unsubscribe](mailto:[email protected]) |
175+
176+
### Star History
174177

175-
The project is licensed under the [Apache License 2.0](LICENSE).
178+
[![Star History Chart](https://api.star-history.com/svg?repos=apache/fesod&type=Date)](https://www.star-history.com/#apache/fesod&Date)
179+
180+
## License
176181

182+
Apache Fesod (Incubating) project is licensed under the [Apache License 2.0](LICENSE).

0 commit comments

Comments
 (0)