Skip to content

Commit

Permalink
Add logo (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
Smaug123 authored May 1, 2024
1 parent f034e23 commit 1f528cf
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 1 deletion.
2 changes: 2 additions & 0 deletions ApiSurface/ApiSurface.fsproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<Description>ApiSurface is a library to help you ensure consistency and documentation coverage of your NuGet package's public API, and to help you adhere to SemVer.</Description>
<Copyright>Copyright (c) G-Research 2022</Copyright>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageIcon>icon-small.png</PackageIcon>
<RepositoryUrl>https://github.com/G-Research/ApiSurface</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
Expand All @@ -32,6 +33,7 @@
<EmbeddedResource Include="SurfaceBaseline.txt" />
<EmbeddedResource Include="version.json" />
<None Include="..\README.md" Pack="true" PackagePath="/" />
<None Include="..\logos\icon-small.png" Pack="true" PackagePath="/" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="FSharp.Core" Version="4.3.4" />
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# ApiSurface

<picture>
<source media="(prefers-color-scheme: dark)" srcset="logos/text-white.png">
<source media="(prefers-color-scheme: light)" srcset="logos/text-darkblue.png">
<img alt="ApiSurface logo: a minimalistic cube, dimetric projection, composed of three stacked layers which are joined at some edges so as to suggest the letter S. The visible parts of the stacked layers inside the cube are light blue; the outer surface is white in dark mode, or dark blue in light mode. To the right is the text 'ApiSurface' in the same colour as the cube's exterior." src="logos/text-darkblue.png">
</picture>

This library provides several modules for ensuring the consistency and documentation coverage of an F# assembly's public API.
It also integrates with [NerdBank.GitVersioning] to help you adhere to [Semantic Versioning](https://semver.org/) principles.

Expand Down Expand Up @@ -55,7 +61,7 @@ Along with monitoring a project's public API, this library can be used to encour
When running the explicit test (see below) to update a project's SurfaceBaseline file, the test will also look for a `version.json` file (in the same location as the SurfaceBaseline file).
If the `version.json` file is not found, an error will be raised.
If the `version.json` file is found, the `version.json` file will be updated with a newer version using the following logic (from https://semver.org/):
* MAJOR version is incremented when backwards incompatible API changes are detected (i.e. API memebers are changed or removed)
* MAJOR version is incremented when backwards incompatible API changes are detected (i.e. API members are changed or removed)
* MINOR version is incremented when added backwards-compatible functionality changes are detected (i.e. API members are added __only__)

If no API changes are detected, the version will not be incremented by the test.
Expand Down
Binary file added logos/icon-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logos/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logos/text-darkblue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logos/text-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1f528cf

Please sign in to comment.