Skip to content

Commit 9921db0

Browse files
authored
Update README.md to include project info.
1 parent 2364998 commit 9921db0

File tree

1 file changed

+46
-2
lines changed

1 file changed

+46
-2
lines changed

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
1-
# openize-open-xml-sdk-net
2-
A .NET library that simplifies working with OpenXML documents. Create, read, and manipulate Wordprocessing documents (Docx), Excel spreadsheets (Xlsx), and PowerPoint presentations (Pptx) effortlessly with Openize.OpenXML SDK. Licensed under MIT.
1+
# Openize.OpenXML SDK for .NET
2+
3+
Openize.OpenXML SDK for .NET is a powerful and easy-to-use wrapper around the OpenXML SDK, enabling developers to work seamlessly with Wordprocessing documents (Docx), Excel spreadsheets (Xlsx), and PowerPoint presentations (Pptx) in their .NET applications.
4+
5+
## Features
6+
- **Word:** Create, read, and manipulate Wordprocessing documents (.docx).
7+
- **Excel:** Create, read, and manipulate Excel spreadsheets (.xlsx).
8+
- **PowerPoint:** Create, read, and manipulate PowerPoint presentations (.pptx).
9+
10+
## Directories
11+
1. **Word:** Contains source code for working with Wordprocessing documents.
12+
2. **Excel:** Contains source code for working with Excel spreadsheets.
13+
3. **PowerPoint:** Contains source code for working with PowerPoint presentations.
14+
15+
## Installation
16+
This project is licensed under the MIT License, so you can freely use it in your projects. To include Openize.OpenXML SDK for .NET in your application, simply clone the repository or add the library to your project via NuGet (coming soon).
17+
18+
## Usage
19+
20+
### Create an Empty Word Document
21+
```csharp
22+
var document = new Openize.Words.Document();
23+
document.Save("word.docx");
24+
Console.WriteLine("Empty word document created !!!");
25+
```
26+
27+
### Create an Empty Excel Spreadsheet
28+
```csharp
29+
var workbook = new Openize.Cells.Workbook();
30+
workbook.Save("excel.xlsx");
31+
Console.WriteLine("Empty excel document created !!!");
32+
```
33+
34+
### Create an Empty PowerPoint Presentation
35+
```csharp
36+
var presentation = Openize.Slides.Presentation.Create("powerpoint.pptx");
37+
presentation.AppendSlide(new Openize.Slides.Slide());
38+
presentation.Save();
39+
Console.WriteLine("Empty Presentation document created !!!");
40+
```
41+
42+
## Contributing
43+
Contributions are welcome! Please fork the repository and submit a pull request. For significant changes, please open an issue first to discuss what you would like to contribute.
44+
45+
## License
46+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)