Skip to content

Commit e7d1cef

Browse files
committed
Add logo to README.md
1 parent 4269b31 commit e7d1cef

File tree

1 file changed

+51
-35
lines changed

1 file changed

+51
-35
lines changed

README.md

Lines changed: 51 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# Virtual File System
1+
<div align="center">
2+
<img src="https://raw.githubusercontent.com/Atypical-Consulting/VirtualFileSystem/main/Logo.png" alt="Virtual File System Logo" width="200" height="200">
3+
<h1>Virtual File System</h1>
4+
</div>
5+
<p align="center">A virtual file system implementation in modern C#.</p>
26

3-
A virtual file system implementation in modern C#.
7+
---
8+
9+
<div align="center">
410

511
[![Atypical-Consulting - VirtualFileSystem](https://img.shields.io/static/v1?label=Atypical-Consulting&message=VirtualFileSystem&color=blue&logo=github)](https://github.com/Atypical-Consulting/VirtualFileSystem "Go to GitHub repo")
612
[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
@@ -15,61 +21,71 @@ A virtual file system implementation in modern C#.
1521

1622
[![NuGet](https://img.shields.io/nuget/v/Atypical.VirtualFileSystem.svg)](https://www.nuget.org/packages/Atypical.VirtualFileSystem)
1723
[![NuGet](https://img.shields.io/nuget/dt/Atypical.VirtualFileSystem.svg)](https://www.nuget.org/packages/Atypical.VirtualFileSystem)
24+
</div>
25+
26+
---
1827

19-
## Table of contents
28+
## 📝 Table of Contents
2029

2130
<!-- TOC -->
22-
* [Virtual File System](#virtual-file-system)
23-
* [Table of contents](#table-of-contents)
24-
* [Introduction](#introduction)
25-
* [What is a virtual file system and why should I use it?](#what-is-a-virtual-file-system-and-why-should-i-use-it)
26-
* [Features](#features)
27-
* [We use the lastest C# features](#we-use-the-lastest-c-features)
28-
* [Installation](#installation)
29-
* [NuGet](#nuget)
30-
* [Source](#source)
31-
* [Usage](#usage)
31+
* [📝 Table of Contents](#-table-of-contents)
32+
* [📖 Introduction](#-introduction)
33+
* [🧐 What is a virtual file system and why should I use it?](#-what-is-a-virtual-file-system-and-why-should-i-use-it)
34+
* [📋 Prerequisites](#-prerequisites)
35+
* [📌 Features](#-features)
36+
* [🚀 We use the latest C# features](#-we-use-the-latest-c-features)
37+
* [📥 Installation](#-installation)
38+
* [📦 NuGet](#-nuget)
39+
* [📁 From source](#-from-source)
40+
* [📚 Use cases](#-use-cases)
3241
* [Creating a virtual file system, add some files and print the content of the root directory as an ASCII tree](#creating-a-virtual-file-system-add-some-files-and-print-the-content-of-the-root-directory-as-an-ascii-tree)
33-
* [Documentation](#documentation)
34-
* [Contributing](#contributing)
35-
* [License](#license)
36-
* [Contact](#contact)
37-
* [Acknowledgements](#acknowledgements)
38-
* [Changelog](#changelog)
39-
* [Contributors](#contributors)
42+
* [📄 Documentation](#-documentation)
43+
* [🤝 Contributing](#-contributing)
44+
* [📜 License](#-license)
45+
* [📬 Contact](#-contact)
46+
* [🙌 Acknowledgements](#-acknowledgements)
47+
* [🎉 Change log](#-change-log)
48+
* [Contributors](#-contributors)
4049
<!-- TOC -->
4150

42-
## Introduction
51+
## 📖 Introduction
4352

4453
When writing applications in .NET, you often need to write or read the contents of a file. .NET provides `System.IO`
4554
namespace dedicated to this purpose. But how do we deal with the filesystem when testing our code?
4655

4756
**Virtual File System** is an attempt to solve this problem. Currently, this library is at an early stage of
4857
development. If you need additional functionality, I invite you to open an issue to discuss it.
4958

50-
### What is a virtual file system and why should I use it?
59+
### 🧐 What is a virtual file system and why should I use it?
5160

5261
A virtual file system is a data structure that represents a file system in memory. It is used to simulate a file system
5362
on a computer. It is useful for testing purposes, for example, when you want to test a file system without actually
5463
creating files on the hard drive.
5564

56-
## Features
65+
### 📋 Prerequisites
66+
67+
- .NET 6.0
68+
- A C# IDE (Visual Studio, Rider, etc.)
69+
- A C# compiler (dotnet CLI, etc.)
70+
71+
## 📌 Features
5772

5873
- [x] Create a virtual file system
5974
- [x] Create a virtual file or directory
75+
- [x] Print the contents of a virtual file system as a tree
6076
- [ ] ...
6177

62-
### We use the lastest C# features
78+
### 🚀 We use the latest C# features
6379

6480
This library targets .NET 7.0 and uses the latest C# features. It is written in C# 11.0 and uses the new `init`
6581
properties, `record` types, `switch` expressions, `using` declarations, and more.
6682

6783
I invite you to read the [C# 11.0 documentation](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-11) to
6884
learn more about these features.
6985

70-
## Installation
86+
## 📥 Installation
7187

72-
### NuGet
88+
### 📦 NuGet
7389

7490
VirtualFileSystem is available on [NuGet](https://www.nuget.org/packages/VirtualFileSystem/).
7591

@@ -85,7 +101,7 @@ or by adding a package reference to your project file:
85101
<PackageReference Include="Atypical.VirtualFileSystem" Version="0.1.1" />
86102
```
87103

88-
### Source
104+
### 📁 From source
89105

90106
You can also clone the repository and build the project yourself.
91107

@@ -95,7 +111,7 @@ cd VirtualFileSystem
95111
dotnet build
96112
```
97113

98-
## Usage
114+
## 📚 Use cases
99115

100116
### Creating a virtual file system, add some files and print the content of the root directory as an ASCII tree
101117

@@ -134,7 +150,7 @@ IVirtualFileSystem vfs = new VFS()
134150
string tree = vfs.ToString();
135151
```
136152

137-
## Documentation
153+
## 📄 Documentation
138154

139155
The documentation is still a work in progress.
140156

@@ -144,31 +160,31 @@ you can read the XML documentation generated on build.
144160
All summaries are written in English. If you want to help us translate the documentation, please open an issue to
145161
discuss it.
146162

147-
## Contributing
163+
## 🤝 Contributing
148164

149165
Contributions are welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first.
150166

151-
## License
167+
## 📜 License
152168

153169
This project is licensed under the terms of the BSD-3-Clause license.
154170
If you use this library in your project, please consider adding a link to this repository in your project's README.
155171

156172
This project is maintained by [Atypical Consulting](https://www.atypical.consulting/). If you need help with this
157173
project, please contact us from this repository by opening an issue.
158174

159-
## Contact
175+
## 📬 Contact
160176

161177
You can contact us by opening an issue on this repository.
162178

163-
## Acknowledgements
179+
## 🙌 Acknowledgements
164180

165181
* [All Contributors](../../contributors)
166182
* [Atypical Consulting](https://www.atypical.consulting/)
167183

168-
## Changelog
184+
## 🎉 Change log
169185

170186
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
171187

172-
## Contributors
188+
## Contributors
173189

174190
[![Contributors](https://contrib.rocks/image?repo=Atypical-Consulting/VirtualFileSystem)](http://contrib.rocks)

0 commit comments

Comments
 (0)