Skip to content

Commit 35d8670

Browse files
committed
updated .gitignore to remove uneeded file references that were being ignored; Added CONTRIBUTING guide; Updated README with NuGet install instructions and Contributors section; Updated .nuspec file to add additional author;
1 parent d423af9 commit 35d8670

File tree

4 files changed

+21
-9
lines changed

4 files changed

+21
-9
lines changed

Diff for: .gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,3 @@ $RECYCLE.BIN/
152152

153153
packages/
154154
*.nupkg
155-
/lz-string-sharp/lz-string-csharp.csproj
156-
/lz-string-sharp/LZString.cs
157-
/lz-string-sharp/LZString.cs

Diff for: CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Contributing to lz-string-csharp
2+
3+
Thank you for your interest in contributing to lz-string-sharp!
4+
5+
## Ways to contribute
6+
7+
You can contribute to lz-string-sharp in a couple of different ways:
8+
9+
- Submit issues through [issue tracker](https://github.com/jawa-the-hutt/lz-string-csharp/issues) on GitHub.
10+
- If you wish to make code changes to lz-string-csharp, or contribute something new, please follow the [GitHub Forks / Pull requests model](https://help.github.com/articles/fork-a-repo/): Fork the repo, make the change and propose it back by submitting a pull request. We would ask that you add some tests with your pull request.

Diff for: README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,20 @@ C# Class implementation of LZ-String javascript
55

66
Based on the LZ-String javascript found here: http://pieroxy.net/blog/pages/lz-string/index.html
77

8-
Import the Class file into your project and change your namespace to match.
98

9+
## Installation
1010

11-
Important:
11+
- Add the NuGet package to your project: `Install-Package LZString`
1212

13-
If you are using this in a web service and are sending in strings that are compressed by the Javascript version of LZ-String, then you will want to use the Javascript function 'compressToUTF16'.
1413

15-
If you use just the regular Javascript 'compress' function then depending on the data in the string, it will not decompress correctly on the C# side.
14+
## Please Note:
1615

16+
If you are using this in a web service and are sending in strings that are compressed by the Javascript version of LZ-String, then you will want to use the Javascript function `compressToUTF16`.
1717

18-
However, if you are using the 'compress' function built into this C# version, then you should be ok to use the regular 'decompress' function included.
18+
If you use just the regular Javascript `compress` function, then depending on the data in the string, it may not decompress correctly on the web service side. However, if you are using the `compress` function built into lz-string-csharp, then you should be ok to use the regular `decompress` function included.
19+
20+
21+
## Contributors ##
22+
23+
lz-string-csharp was created by [jawa-the-hutt](https://github.com/jawa-the-hutt), with several necessary improvements made by [christianrondeau](https://github.com/christianrondeau)
1924

Diff for: src/lz-string-csharp.nuspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<id>LZString</id>
55
<version>$version$</version>
66
<title>LZString</title>
7-
<authors>jawa-the-hutt</authors>
7+
<authors>jawa-the-hutt,Christian Rondeau</authors>
88
<owners>jawa-the-hutt</owners>
99
<licenseUrl>https://github.com/jawa-the-hutt/lz-string-csharp/blob/master/LICENSE</licenseUrl>
1010
<projectUrl>https://github.com/jawa-the-hutt/lz-string-csharp</projectUrl>

0 commit comments

Comments
 (0)