Update documentation

Author: Systemcluster

.github/workflows/tests.yml

@@ -59,6 +59,28 @@ jobs:
       - name: Check no-default-features with std
         run: cargo check --no-default-features --features std
 
+  docs:
+
+    name: Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          show-progress: false
+
+      - name: Set up Rust toolchain
+        uses: Systemcluster/actions@setup-rust-v0
+        with:
+          channel: nightly
+          cache-key-job: true
+
+      - name: Check docs.rs
+        env:
+          RUSTDOCFLAGS: --cfg docsrs
+        run: cargo doc
+
   tests:
 
     name: Tests

README.md

@@ -20,14 +20,13 @@ Compared to other resource editors like [rcedit](https://github.com/electron/rce
 
 ### Library
 
-Add `editpe` as a dependency. Support for converting and resizing images in other formats when setting icons is provided by the `image` crate.
+Add `editpe` as a dependency. The `std` and `images` features are enabled by default and can be disabled for `no-std` support.
 
 ```toml
 editpe = "0.2"
-image = "*" # to support additional icon file types
+image = { version = "*", features = ["png"] } # to support additional icon file types
 ```
 
-The `std` and `images` features are enabled by default and can be disabled for `no-std` support.
 
 #### Examples
 

src/lib.rs

@@ -11,37 +11,30 @@
 //!
 //! # Examples
 //!
-//! ### Replacing the icon of an executable
+//! ### Adding an icon or manifest to an executable
 //! ```
-//! use editpe::Image;
-//!
+//! # use editpe::Image;
 //! let mut image = Image::parse_file("damocles.exe")?;
-//!
-//! // get the resource directory
 //! let mut resources = image.resource_directory().cloned().unwrap_or_default();
-//! // set the icon file
+//!
 //! resources.set_main_icon_file("sword.png")?;
-//! // set the resource directory in the image
-//! image.set_resource_directory(resources)?;
 //!
-//! // write an executable image with all changes applied
+//! let manifest = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>";
+//! resources.set_manifest(manifest)?;
+//!
+//! image.set_resource_directory(resources)?;
 //! image.write_file("damocles.exe");
 //! ```
 //!
 //! ### Transferring resources between executables
 //! ```
-//! use editpe::Image;
-//!
-//! let image = Image::parse_file("damocles.exe")?;
-//! // get the resource directory from the source
+//! # use editpe::Image;
+//! let source = Image::parse_file("damocles.exe")?;
 //! let resources = image.resource_directory()?;
 //!
-//! let mut image = Image::parse_file("fortuna.exe")?;
-//! // copy the resource directory to the target
-//! image.set_resource_directory(resources)?;
-//!
-//! // write an executable image with all changes applied
-//! image.write_file("fortuna.exe");
+//! let mut target = Image::parse_file("fortuna.exe")?;
+//! target.set_resource_directory(resources)?;
+//! target.write_file("fortuna.exe");
 //! ```
 //!
 //! # Cargo features
@@ -52,8 +45,8 @@
 //! - `images`: Enables support for converting and resizing images in other formats when setting icons. Also enables `std`.
 
 #![cfg_attr(not(feature = "std"), no_std)]
-#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg_hide))]
-#![cfg_attr(docsrs, doc(cfg_hide(doc)))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, doc(auto_cfg))]
 
 extern crate alloc;