nuget doc content

NUGET-DOC.md

@@ -0,0 +1,56 @@
+If you are calling a REST operation you will need to create a gateway to manage the request. There are a few different ones but the most basic is called `PortalGateway` and this can be used for connecting directly to services with ArcGIS Server.
+
+Create an instance of that by specifying the root url of your server. The format of the root url is _scheme_://_host_:_port_/_instance_ so a typical default ArcGIS Server for your local machine would be _http://localhost:6080/arcgis_, note that you do not need to include `rest/services` in either the root url or your relative urls as it gets added automatically. One thing to look out for is that the url is case sensitive so make sure you enter it correctly.
+
+```c#
+var gateway = new PortalGateway("https://sampleserver3.arcgisonline.com/ArcGIS/");
+```
+
+Now you have access to the various operations supported by it. For example to call a query against a service
+
+```c#
+var query = new Query("Earthquakes/EarthquakesFromLastSevenDays/MapServer/0".AsEndpoint())
+{ 
+    Where = "magnitude > 4.0" 
+};
+var result = await gateway.Query<Point>(query);
+```
+
+### Capabilities
+
+Supports the following as typed operations:
+
+ - `CheckGenerateToken` create a token automatically via an `ITokenProvider`
+ - `Query` query a layer by attribute and / or spatial filters, also possible to do `BatchQuery`
+ - `QueryForCount` only return the number of results for the query operation
+ - `QueryForIds` only return the ObjectIds for the results of the query operation
+ - `QueryForExtent` return the bounding extent for the result of the query operation
+ - `Find` search across _n_ layers and fields in a service
+ - `ApplyEdits` post adds, updates and deletes to a feature service layer
+ - `Geocode` single line of input to perform a geocode using a custom locator or the Esri world locator
+ - `Suggest` lightweight geocode operation that only returns text results, commonly used for predictive searching
+ - `ReverseGeocode` find location candidates for a input point location
+ - `Simplify` alter geometries to be topologically consistent
+ - `Project` convert geometries to a different spatial reference
+ - `Buffer` buffers geometries by the distance requested
+ - `DescribeSite` returns a url for every service discovered
+ - `CreateReplica` create a replica for a layer
+ - `UnregisterReplica` unregister a replica based on the Id
+ - `DeleteAttachments` delete attachments that are associated with a feature
+ - `Ping` verify that the server can be accessed
+ - `Info` return the server information such as version and token authentication settings
+ - `DescribeServices` return services information (name, sublayers etc.)
+ - `DescribeService` return service information (name, sublayers etc.)
+ - `DescribeLayer` return layer information
+
+REST admin operations:
+
+ - `PublicKey` - admin operation to get public key used for encryption of token requests
+ - `ServiceStatus` - admin operation to get the configured and actual status of a service
+ - `ServiceReport` - admin operation to get the service report
+ - `StartService` - admin operation to start a service
+ - `StopService` - admin operation to stop a service
+
+There are also methods to add / update and download attachments for a feature and you can extend this library by writing your own operations.
+
+Refer to the integration test project for more examples.s