readme

.gitignore

@@ -0,0 +1 @@
+**/node_modules

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 cadenmarinozzi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,65 @@
+# CSFormat
+
+CSFormat is the only package you need to format CS2 item queries into the Steam Market format.
+
+# Supported item types
+
+- Weapons
+- Gloves
+- Knives
+- Stickers
+- Cases
+- Case Keys
+- Music Kits
+- Music Kit Boxes
+- Patches
+
+# Installation
+
+```bash
+npm install csformat
+```
+
+# Usage
+
+Example:
+
+```javascript
+const MarketHashNameBuilder = require("csformat");
+
+const builder = new MarketHashNameBuilder();
+
+const result = builder.build("★ Karambit | Doppler (Factory New)");
+```
+
+# Testing
+
+```bash
+npm test
+```
+
+# Reporting bugs/wrong formatting
+
+If you find any bugs or wrong formatting, please open an issue on the [GitHub repository](https://github.com/cadenmarinozzi/CSFormat).
+
+# TODO
+
+- Add support for
+
+  - Graffiti
+  - Agents
+  - Collectibles aka Pins
+  - Souvenir Packages
+  - Zeus x27
+  - Gifts
+  - Passes
+  - Tools
+  - Name tags
+
+- Rewrite in TypeScript
+- Add more tests
+- Add formatting string list
+
+# LICENSE
+
+CSFormat is licensed under the MIT License. See [LICENSE](LICENSE) for more information.