Skip to content

Commit 45c858b

Browse files
committed
Create README.md
1 parent d6d1ac0 commit 45c858b

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# StringExtension
2+
A string processing library for the C# programming language. It provides features to manipulate and transform strings in a simple and efficient way. The library is open-source and provided with unit tests and performance tests. It is designed to be easily integrated into your existing projects. Feel free to contribute to the project with ideas or development expertise.
3+
4+
## Features
5+
6+
- RemoveCharacters - removes the specified characters from a string
7+
- IsValidEmail - validate an e-mail address
8+
- IsValidPhoneNumber - validate a phone number
9+
- CountSubstring - counts the number of occurrences of a string in the specified string
10+
- ReverseWords - reverses the order of words in the specified string
11+
- IsPalindrome - determines if a given string is a [palindrome](https://en.wikipedia.org/wiki/Palindrome)
12+
- CountLetters - counts the number of letters in a given string.
13+
- RemoveDuplicateCharacters - remove duplicate characters from a given string.
14+
- ConvertToCamelCase - converts a given string to camel case.
15+
16+
## Installation
17+
18+
Install [StringExtension](https://www.nuget.org/packages/String-Extension/) using the following NuGet command
19+
```bash
20+
nuget install String-Extension
21+
```
22+
23+
24+
## Running Tests
25+
- The unit tests are [here](https://github.com/Antyss77/Strings/blob/master/StringsTests/StringsTests.cs)
26+
- The performance tests are [here](https://github.com/Antyss77/Strings/blob/master/StringsTests/StringsPerf.cs)
27+
28+
## Licence
29+
Distributed under the MIT License. See [LICENCE](https://github.com/Antyss77/Strings/blob/master/LICENSE) for more information.
30+
31+
## Contributing
32+
You can contribute to the project in several ways: by proposing new ideas, reporting bugs you encounter, or improving existing code. If you would like to submit a change, you can open a Pull Request so that we can review your changes and incorporate them into the project if necessary. We welcome your participation and look forward to moving this string library project forward.
33+
34+

0 commit comments

Comments
 (0)