Skip to content

Commit e92055f

Browse files
author
GaProgMan
committed
Removed unecessary sections
1 parent dd09f3d commit e92055f

File tree

1 file changed

+1
-51
lines changed

1 file changed

+1
-51
lines changed

README.md

+1-51
Original file line numberDiff line numberDiff line change
@@ -42,56 +42,6 @@ It has been released, as is, using an MIT licence. For more information on the M
4242

4343
This will start the Kestrel webserver, load the `dwCheckApi` application and tell you, via the terminal, what the url to access `dwCheckApi` will be. Usually this will be `http://localhost:5000`, but it may be different based on your system configuration.
4444

45-
46-
### .NET Core Build Information
47-
48-
The following commands can be used to run different versions of dwCheckApi
49-
50-
dotnet bin/Debug/netcoreapp1.0/dwCheckApi.dll (for the debug build)
51-
52-
dotnet bin/Release/netcoreapp1.0/dwCheckApi.dll (for the release build)
53-
54-
This set of commands explicitly inform the .NET Core runtime which build of the server we would like to run.
55-
56-
If you do not explicitly provide a configuration in the build step, then the debug version of dwCheckApi will be built. If you explicitly request a Release build, but issue `dotnet run`, then a debug version of dwCheckApi will be built.
57-
58-
To request a Release build of dwCheckApi, then the following command should produce one:
59-
60-
dotnet build --configuration Release
61-
62-
## View Models
63-
64-
The data returned from `dwCheck`'s server is in a slightly different, more simplified format, than that used for the Database Models.
65-
66-
1. Book
67-
68-
The `Book` view model represents a novel in the Discworld series, and the names of any linked characters are included.
69-
70-
The `Book` view model contains the following fields:
71-
72-
| Property | Type | Description |
73-
| ------------------| -----------------|----------------------|
74-
| BookOrdinal | int | Release Order |
75-
| BookName | string | Book Name |
76-
| BookIsbn10 | string | ISBN 10 of the book |
77-
| BookIsbn13 | string | ISBN 13 of the book |
78-
| BookDescription | string | Book description (taken from the back of the book) |
79-
| BookCoverImage | byte array | Represents the image for the cover art |
80-
| BookCoverImageUrl | string | is a URL to the cover art (to be used as a backup, if BookCoverImage is null) |
81-
| Characters | array of strings | an array, containing 0 or more entries, of character name strings |
82-
83-
1. Character
84-
85-
The `Character` view model represents a character from the Discworld universe, and the names of any books they have appeared as major characters in are included.
86-
87-
The `Character` view model contains the following fields:
88-
89-
| Property | Type | Description |
90-
| ------------------| -----------------|----------------------|
91-
| CharacterName | string | Character's Name |
92-
| Books | array of strings | An array, containing 0 or more entires, of book title strings |
93-
94-
9545
## Polling and Usage of the API
9646

9747
`dwCheckApi` has the following Controllers:
@@ -241,7 +191,7 @@ The data returned from `dwCheck`'s server is in a slightly different, more simpl
241191

242192
# Seeding the Database
243193

244-
There are aseries of API endpoints related to clearing and seeding the database. These can be found at:
194+
There are a series of API endpoints related to clearing and seeding the database. These can be found at:
245195

246196
/Database/DropData
247197
/Database/SeedData

0 commit comments

Comments
 (0)