Skip to content

Commit

Permalink
Update description
Browse files Browse the repository at this point in the history
  • Loading branch information
jjonescz committed Mar 20, 2021
1 parent d5ce06b commit 988bcaa
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Nuget](https://img.shields.io/nuget/v/KnowledgePicker.WordCloud?logo=nuget)](https://www.nuget.org/packages/KnowledgePicker.WordCloud/)
[![GitHub](https://img.shields.io/github/last-commit/knowledgepicker/word-cloud/master?logo=github)](https://github.com/knowledgepicker/word-cloud)

`KnowledgePicker.WordCloud` is a modern (.NET Standard 2.0) and fast library for arranging and drawing [word clouds](https://knowledgepicker.com/t/427/tag-word-cloud) (a.k.a. tag clouds or wordle).
`KnowledgePicker.WordCloud` is a modern (.NET Standard 2.0) and fast library for arranging and drawing [word clouds](https://knowledgepicker.com/t/427/tag-word-cloud) (a.k.a. tag clouds or wordle). It uses Quadtrees for blazing-fast performance. It is maintained by the [KnowledgePicker](https://knowledgepicker.com) team.

![Sample Word Cloud](example.png)

Expand Down Expand Up @@ -82,6 +82,12 @@
The world cloud algorithm was initially ported from [SourceCodeCloud](https://archive.codeplex.com/?p=sourcecodecloud). It uses [Quadtrees](https://en.wikipedia.org/wiki/Quadtree), hence it should be reasonably fast. It is inspired by [implementation of Wordle](https://stackoverflow.com/a/1478314) (once famous algorithm used on
now-defunct site [wordle.net](https://web.archive.org/web/20201206102909/http://www.wordle.net/)).

## Examples

Simple console application which draws word cloud PNG for words given on its standard input is [`WordFrequencies.ConsoleApp`](examples/WordFrequency.ConsoleApp).

This library is also used in production by [KnowledgePicker](https://knowledgepicker.com). They use it to draw [topic clouds for user profiles](https://knowledgepicker.com/profiles).

## Contributing

As mentioned [above](#how-to-use), only subset of functionality is implemented now, but all contributions are welcome. Feel free to open [issues](https://github.com/knowledgepicker/word-cloud/issues) and [pull requests](https://github.com/knowledgepicker/word-cloud/pulls).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<Company>KnowledgePicker</Company>
<Title>Word Cloud for .NET</Title>
<Description>Modern and fast library for arranging and drawing word clouds (a.k.a. tag clouds or wordle).</Description>
<Description>
Modern and fast library for arranging and drawing word clouds (a.k.a. tag clouds or wordle).
Uses Quadtrees for blazing-fast performance.
Maintained by the KnowledgePicker team.
</Description>
<Authors>KnowledgePicker</Authors>
<Copyright>Copyright 2021 Jan Joneš</Copyright>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
Expand Down

0 comments on commit 988bcaa

Please sign in to comment.