Skip to content

Commit aaf5203

Browse files
Fixed github workflows to include dotnet 9.0, added a gif, improved readme.md
1 parent 62af420 commit aaf5203

File tree

4 files changed

+50
-7
lines changed

4 files changed

+50
-7
lines changed

.github/workflows/dotnet.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
- name: Setup .NET
2020
uses: actions/setup-dotnet@v4
2121
with:
22-
dotnet-version: 8.0.x
22+
dotnet-version: 9.0.x
2323
- name: Restore dependencies
2424
run: dotnet restore
2525
- name: Build

buffer.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<Nullable>enable</Nullable>
88
<GenerateDocumentationFile>true</GenerateDocumentationFile>
99

10-
<Version>2.1.0</Version>
10+
<Version>2.1.1</Version>
1111
<Authors>Pradosh (helloImPR)</Authors>
1212
<Description>A fast, completely controllable input method solution for C#.</Description>
1313
<PackageLicenseExpression>MIT</PackageLicenseExpression>

buffer.gif

20.7 MB
Loading

readme.md

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1+
![Buffer package in action](./buffer.gif)
2+
13
## Better Input for C#
4+
25
Have you ever wondered if you could get the values of what users are typing in real time with `Console.ReadLine()` function? or do you want full control of input?
36

47
Well don't worry! This `buffer` nuget package aims to solve the issues of `ReadLine()` and gives more control to the user!
58

9+
### Features
10+
- Data updates in real time.
11+
- Control of buffer when to clear and when to call next time.
12+
- Directly get the buffer as a character array.
13+
- Supports multithreading to have extra control.
14+
- Supports a wide range of .NET Frameworks.
15+
616
### Usage
717

818
#### Process
@@ -15,8 +25,8 @@ Well don't worry! This `buffer` nuget package aims to solve the issues of `ReadL
1525
4. Clear the buffer (you have to do it **manually** by invoking a method)
1626
```
1727

18-
#### Example Syntax
19-
```cs
28+
#### Example Usage
29+
```cpp
2030
PradBuffer InputBuffer = new PradBuffer();
2131

2232
InputBuffer.GetInput();
@@ -31,7 +41,7 @@ The input function is overloaded so there are two different ways to use it.
3141

3242
#### Method 1
3343
`code.cs`
34-
```cs
44+
```cpp
3545
InputBuffer.GetInput();
3646
```
3747

@@ -42,11 +52,44 @@ InputBuffer.GetInput();
4252

4353
#### Method 2
4454
`code.cs`
45-
```cs
55+
```cpp
4656
InputBuffer.GetInput("command > ");
4757
```
4858

4959
`output:`
5060
```
5161
command > <waits here for input>
52-
```
62+
```
63+
64+
### Importing the package
65+
You can check out the [nuget.org](https://www.nuget.org/packages/buffer) site for extra detailed installation.
66+
67+
For simply just dotnet :
68+
```bash
69+
dotnet add package buffer
70+
```
71+
72+
### Contributing
73+
74+
Contributions are welcome! Please follow these steps:
75+
76+
1. Fork the repository.
77+
2. Create a new branch:
78+
```bash
79+
git checkout -b feature-name
80+
```
81+
3. Commit your changes:
82+
```bash
83+
git commit -m "Add feature-name"
84+
```
85+
4. Push to your branch:
86+
```bash
87+
git push origin feature-name
88+
```
89+
5. Open a pull request.
90+
91+
### Contribution guidelines
92+
- Follow the existing code style.
93+
- Write clear and concise commit messages.
94+
- Ensure that your code is well-documented.
95+
- Write tests for new features and ensure all tests pass before submitting a pull request.

0 commit comments

Comments
 (0)