You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+48-5Lines changed: 48 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,18 @@
1
+

2
+
1
3
## Better Input for C#
4
+
2
5
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?
3
6
4
7
Well don't worry! This `buffer` nuget package aims to solve the issues of `ReadLine()` and gives more control to the user!
5
8
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
+
6
16
### Usage
7
17
8
18
#### Process
@@ -15,8 +25,8 @@ Well don't worry! This `buffer` nuget package aims to solve the issues of `ReadL
15
25
4. Clear the buffer (you have to do it **manually** by invoking a method)
16
26
```
17
27
18
-
#### Example Syntax
19
-
```cs
28
+
#### Example Usage
29
+
```cpp
20
30
PradBuffer InputBuffer = new PradBuffer();
21
31
22
32
InputBuffer.GetInput();
@@ -31,7 +41,7 @@ The input function is overloaded so there are two different ways to use it.
31
41
32
42
#### Method 1
33
43
`code.cs`
34
-
```cs
44
+
```cpp
35
45
InputBuffer.GetInput();
36
46
```
37
47
@@ -42,11 +52,44 @@ InputBuffer.GetInput();
42
52
43
53
#### Method 2
44
54
`code.cs`
45
-
```cs
55
+
```cpp
46
56
InputBuffer.GetInput("command > ");
47
57
```
48
58
49
59
`output:`
50
60
```
51
61
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