https://github.com/galassie/fslugify-adapter
📦🐌 Minimalistic adapter for a minimalistic slug generator library
https://github.com/galassie/fslugify-adapter
csharp slug slugify url web
Last synced: 2 months ago
JSON representation
📦🐌 Minimalistic adapter for a minimalistic slug generator library
- Host: GitHub
- URL: https://github.com/galassie/fslugify-adapter
- Owner: galassie
- License: mit
- Created: 2019-11-04T23:05:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-02T14:05:32.000Z (about 4 years ago)
- Last Synced: 2024-12-30T04:27:22.893Z (4 months ago)
- Topics: csharp, slug, slugify, url, web
- Language: C#
- Homepage:
- Size: 35.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FSlugify-Adapter
[](https://ci.appveyor.com/project/galassie/fslugify-adapter) [](https://travis-ci.org/galassie/fslugify-adapter) [](https://nuget.org/packages/FSlugify.Adapter) 
Simple, Object-Oriented adapter for the library [FSlugify](https://github.com/galassie/fslugify), written in C#.
## Add package
If you want to add this package to your project, execute the following command:
``` shell
dotnet add package FSlugify.Adapter --version 1.1.0
```
## Build on your machine
If you want to build this library on your machine, execute the following commands:
``` shell
git clone https://github.com/galassie/fslugify.git
cd fslugify
dotnet build
```
If you want to run the tests, execute the following command:
``` shell
dotnet test
```
## Build in Docker
Required:
- Install [Docker](https://hub.docker.com/search/?type=edition&offering=community) for your system
Build a Docker image called `fslugify-adapter`. This will work without any local .NET Core installation.
```shell
docker build -t fslugify-adapter .
```
Use the following to instantiate a Docker container from the `fslugify-adapter` image and run the tests inside:
```shell
docker run --rm fslugify-adapter dotnet test
```
## Contributing
Code contributions are more than welcome! 😻
Please commit any pull requests against the `master` branch.
If you find any issue, please [report it](https://github.com/galassie/fslugify-adapter/issues)!
## License
This project is licensed under [The MIT License (MIT)](https://raw.githubusercontent.com/galassie/fslugify-adapter/master/LICENSE.md).
Author: [Enrico Galassi](https://twitter.com/enricogalassi88)