Merge branch 'dev'

* dev: fixed config update doc, update dep, update copyright update doc and badges update README
leonardwoo · Jan 9, 2024 · 7d44916 · 7d44916
2 parents dcbcdcf + f1035e5
commit 7d44916
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 48 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+.vscode/
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -1,5 +1,10 @@
 = Favicon
 
+== 0.5.0 2024-01-09
+. Update document
+. Update Copyright
+. Update dependencies
+
 == 0.4.0 2023-06-21
 . Add `-v` for display version
 . Update help

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,11 +1,11 @@
 [package]
 name = "favicon-rs"
-version = "0.4.0"
+version = "0.5.0"
 edition = "2021"
 authors = ["Leonard Woo <leo_916@yahoo.com>"]
 license = "BSD-3-Clause"
 description = "A favicon generation tool"
-readme = "README.adoc"
+readme = "README.md"
 keywords = ["cli", "favicon"]
 categories = ["command-line-utilities"]
 homepage = "https://github.com/leonardwoo/favicon-rs"
@@ -18,8 +18,8 @@ path = "src/main.rs"
 bench = false
 
 [dependencies]
-image = "0.24.5"
-futures = "0.3"
+image = "0.24.7"
+futures = "0.3.30"
 
 [package.metadata.winres]
 FileDescription = "Favicon toolkit with Rust"

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2023 Leonard Woo
+Copyright (c) 2024 Leonard Woo
 
 Redistribution and use in source and binary forms, with or without 
 modification, are permitted provided that the following conditions are met:

diff --git a/README.adoc b/README.adoc
diff --git a/README.md b/README.md
@@ -0,0 +1,38 @@
+# Favicon
+
+[!["License"](https://img.shields.io/github/license/leonardwoo/favicon-rs?style=flat-square)](https://github.com/leonardwoo/favicon-rs/blob/main/LICENSE)
+[!["Crates.io"](https://img.shields.io/crates/d/favicon-rs?style=flat-square)](https://srl.cx/jIUoJvBB)
+[!["Crates.io"](https://img.shields.io/crates/v/favicon-rs?style=flat-square)](https://srl.cx/jIUoJvBB)
+
+## Introduction
+
+A favicon image generation tool.
+
+## Install
+
+```shell
+cargo install favicon-rs
+```
+
+## Usage
+
+```shell
+favicon -i <image.png> [output_path]
+```
+
+## HTML Favicon
+
+```html
+<head>
+
+<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
+<!-- OR -->
+<link rel="icon" type="image/x-icon" href="/favicon.ico" />
+
+<link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png" />
+<link rel="icon" type="image/png" sizes="192x192" href="android-chrome-192x192.png" />
+<link rel="icon" type="image/png" sizes="512x512" href="android-chrome-512x512.png" />
+<link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png" />
+
+</head>
+```
diff --git a/build.rs b/build.rs
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Leonard Woo
+ * Copyright (c) 2024 Leonard Woo
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -36,7 +36,7 @@ extern crate winres;
 fn main() {
     let mut res = winres::WindowsResource::new();
     // res.set_icon("resources/favicon.ico");
-    res.set_language(0x0409);
+    res.set_language(0x0409); // en-US
     res.set_manifest_file("resources/manifest.xml");
     res.compile().unwrap();
 }

diff --git a/src/main.rs b/src/main.rs
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Leonard Woo
+ * Copyright (c) 2024 Leonard Woo
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,3 +12,4 @@ Cargo.lock

		# MSVC Windows builds of rustc generate these, which store debugging information
		*.pdb
		.vscode/