Skip to content

Commit cd19a99

Browse files
committed
Updating README preparing 3.0.0 stable release.
1 parent c95d482 commit cd19a99

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## Sound Fingerprinting MSSQL
22
_soundfingerprinting.sql_ persistent storage implementation which allows storing [soundfingerprinting](https://github.com/AddictedCS/soundfingerprinting) algorithm's data objects in _MSSQL_ database.
33
## Usage
4-
The MSSQL database initialization script can be find [here](src/Scripts/DBScript.sql). Do not forget to add connection string <code>FingerprintConnectionString</code> in your app.config file.
4+
The MSSQL database initialization script can be find [here](src/Scripts/DBScript.sql). Do not forget to add connection string `FingerprintConnectionString` in your `app.config` filex
55
```xml
66
<connectionStrings>
77
<add name="FingerprintConnectionString" connectionString="Data Source=(local);Initial Catalog=FingerprintsDb;Integrated Security=True; Connection Timeout=15;" providerName="System.Data.SqlClient"/>
88
</connectionStrings>
99
```
10-
Use <code>SqlModelService</code> class when fingerprinting and querying
10+
Use `SqlModelService` class when fingerprinting and querying
1111
```csharp
1212
private readonly IModelService modelService = new SqlModelService(); // SQL back end
1313
private readonly IAudioService audioService = new NAudioService(); // use NAudio audio processing library
@@ -32,9 +32,15 @@ public void StoreAudioFileFingerprintsInStorageForLaterRetrieval(string pathToAu
3232
modelService.InsertHashedFingerprintsForTrack(hashedFingerprints, trackReference); // insert in SQL backend
3333
}
3434
```
35-
## Binaries
35+
### Binaries
3636
git clone [email protected]:AddictedCS/soundfingerprinting.sql.git
37-
In order to build latest version of the <code>SoundFingerprinting.SQL</code> assembly run the following command from repository root
37+
In order to build latest version of the `SoundFingerprinting.SQL` assembly run the following command from repository root
3838
.\build.cmd
39-
## Get it on NuGet
39+
### Get it on NuGet
4040
Install-Package SoundFingerprinting.SQL
41+
42+
### Contribute
43+
If you want to contribute you are welcome to open issues or discuss on [issues](https://github.com/AddictedCS/soundfingerprinting/issues) page. Feel free to contact me for any remarks, ideas, bug reports etc.
44+
45+
### Licence
46+
The framework is provided under [MIT](https://opensource.org/licenses/MIT) licence agreement.

0 commit comments

Comments
 (0)