13 |
14 |
22 |
23 |
15 |
20 |
21 |
16 | The S3Provider library can be installed from NuGet:
17 |
19 | PM> Install-Package S3Provider18 |
24 |
25 | Example
26 | -------
27 |
28 | This example demonstrates using a function defined in this sample library.
29 |
30 | *)
31 | #r "S3Provider.dll"
32 | #r "AWSSDK.dll"
33 |
34 | (**
35 | Some more info
36 |
37 | Samples & documentation
38 | -----------------------
39 |
40 | The library comes with comprehensible documentation.
41 | It can include a tutorials automatically generated from `*.fsx` files in [the content folder][content].
42 | The API reference is automatically generated from Markdown comments in the library implementation.
43 |
44 | * [Tutorial](tutorial.html) contains a further explanation of this sample library.
45 |
46 | * [API Reference](reference/index.html) contains automatically generated documentation for all types, modules
47 | and functions in the library. This includes additional brief samples on using most of the
48 | functions.
49 |
50 | Contributing and copyright
51 | --------------------------
52 |
53 | The project is hosted on [GitHub][gh] where you can [report issues][issues], fork
54 | the project and submit pull requests. If you're adding new public API, please also
55 | consider adding [samples][content] that can be turned into a documentation. You might
56 | also want to read [library design notes][readme] to understand how it works.
57 |
58 | The library is available under Public Domain license, which allows modification and
59 | redistribution for both commercial and non-commercial purposes. For more information see the
60 | [License file][license] in the GitHub repository.
61 |
62 | [content]: https://github.com/theburningmonk/S3Provider/tree/master/docs/content
63 | [gh]: https://github.com/theburningmonk/S3Provider
64 | [issues]: https://github.com/theburningmonk/S3Provider/issues
65 | [readme]: https://github.com/theburningmonk/S3Provider/blob/master/README.md
66 | [license]: https://github.com/theburningmonk/S3Provider/blob/master/LICENSE.txt
67 | *)
68 |
--------------------------------------------------------------------------------
/docs/content/tutorial.fsx:
--------------------------------------------------------------------------------
1 | (*** hide ***)
2 | // This block of code is omitted in the generated HTML documentation. Use
3 | // it to define helpers that you do not want to show in the documentation.
4 | #I "../../bin"
5 |
6 | (**
7 | Introducing your project
8 | ========================
9 |
10 | Say more
11 |
12 | *)
13 | #r "S3Provider.dll"
14 | #r "AWSSDK.dll"
15 |
16 | (**
17 | Coming soon
18 | *)
19 |
--------------------------------------------------------------------------------
/docs/files/img/demo_screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fsprojects/S3Provider/082a26f9584b0053778091348e7ef40219c35fff/docs/files/img/demo_screenshot.png
--------------------------------------------------------------------------------
/docs/files/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fsprojects/S3Provider/082a26f9584b0053778091348e7ef40219c35fff/docs/files/img/logo.png
--------------------------------------------------------------------------------
/docs/tools/generate.fsx:
--------------------------------------------------------------------------------
1 | // --------------------------------------------------------------------------------------
2 | // Builds the documentation from `.fsx` and `.md` files in the 'docs/content' directory
3 | // (the generated documentation is stored in the 'docs/output' directory)
4 | // --------------------------------------------------------------------------------------
5 |
6 | // Binaries that have XML documentation (in a corresponding generated XML file)
7 | let referenceBinaries = [ "S3Provider.dll" ]
8 | // Web site location for the generated documentation
9 | let website = "/S3Provider"
10 |
11 | // Specify more information about your project
12 | let info =
13 | [ "project-name", "S3Provider"
14 | "project-author", "Yan Cui"
15 | "project-summary", "A F# type provider for Amazon S3"
16 | "project-github", "http://github.com/theburningmonk/S3Provider"
17 | "project-nuget", "http://nuget.org/packages/S3Provider" ]
18 |
19 | // --------------------------------------------------------------------------------------
20 | // For typical project, no changes are needed below
21 | // --------------------------------------------------------------------------------------
22 |
23 | #I "../../packages/FSharp.Formatting.2.1.6/lib/net40"
24 | #I "../../packages/RazorEngine.3.3.0/lib/net40/"
25 | #r "../../packages/Microsoft.AspNet.Razor.2.0.30506.0/lib/net40/System.Web.Razor.dll"
26 | #r "../../packages/FAKE/tools/FakeLib.dll"
27 | #r "RazorEngine.dll"
28 | #r "FSharp.Literate.dll"
29 | #r "FSharp.CodeFormat.dll"
30 | #r "FSharp.MetadataFormat.dll"
31 | open Fake
32 | open System.IO
33 | open Fake.FileHelper
34 | open FSharp.Literate
35 | open FSharp.MetadataFormat
36 |
37 | // When called from 'build.fsx', use the public project URL as
24 |
32 |
55 |
25 |
29 |
31 | @Properties["project-name"]
30 |32 |
33 |
54 |
34 | @RenderBody()
35 |
36 |
37 |
52 |
53 | 
56 |
57 |
58 |
--------------------------------------------------------------------------------
/lib/README.md:
--------------------------------------------------------------------------------
1 | This file is in the `lib` directory.
2 |
3 | Any **libraries** on which your project depends and which are **NOT managed via NuGet** should be kept **in this directory**.
4 | This typically includes custom builds of third-party software, private (i.e. to a company) codebases, and native libraries.
5 |
6 | ---
7 | NOTE:
8 |
9 | This file is a placeholder, used to preserve directory structure in Git.
10 |
11 | This file does not need to be edited.
12 |
--------------------------------------------------------------------------------
/nuget/README.md:
--------------------------------------------------------------------------------
1 | This file is in the `nuget` directory.
2 |
3 | You should use this directory to store any artifacts required to produce a NuGet package for your project.
4 | This typically includes a `.nuspec` file and some `.ps1` scripts, for instance.
5 | Additionally, this example project includes a `.cmd` file suitable for manual deployment of packages to http://nuget.org.
6 |
7 | ---
8 | NOTE:
9 |
10 | This file is a placeholder, used to preserve directory structure in Git.
11 |
12 | This file does not need to be edited.
13 |
--------------------------------------------------------------------------------
/nuget/S3Provider.nuspec:
--------------------------------------------------------------------------------
1 |
2 |